chat 4.26.0 → 4.28.1

package/docs/streaming.mdx

@@ -6,7 +6,7 @@ prerequisites:
   - /docs/usage
 ---
 
-Chat SDK accepts any `AsyncIterable<string>` as a message, enabling real-time streaming of AI responses and other incremental content to chat platforms. For platforms with native streaming support (Slack), you can also stream structured `StreamChunk` objects for rich content like task progress cards and plan updates.
+Chat SDK accepts any `AsyncIterable<string>` as a message, enabling real-time streaming of AI responses and other incremental content to chat platforms. For platforms with native or structured streaming support, you can also stream `StreamChunk` objects for rich content like task progress cards and plan updates.
 
 ## AI SDK integration
 
@@ -59,9 +59,14 @@ await thread.post(stream);
 | Platform | Method | Description |
 |----------|--------|-------------|
 | Slack | Native streaming API | Uses Slack's `chatStream` for smooth, real-time updates |
-| Teams | Post + Edit | Posts a message then edits it as chunks arrive |
+| Teams | Native (DMs) / Buffered (group chats) | Uses the Teams SDK's native `stream.emit()` for direct messages; accumulates chunks and posts one final message when no native streamer is active |
 | Google Chat | Post + Edit | Posts a message then edits it as chunks arrive |
 | Discord | Post + Edit | Posts a message then edits it as chunks arrive |
+| Telegram | Post + Edit | Posts a message then edits it as chunks arrive |
+| GitHub | Buffered | Accumulates chunks and posts one final comment |
+| Linear | Agent sessions / Post + Edit | Uses agent session activities in agent-session threads; falls back to post+edit comments in issue threads |
+| WhatsApp | Buffered | Accumulates chunks and sends one final message |
+| Messenger | Buffered | Accumulates chunks and sends one final message |
 
 The post+edit fallback throttles edits to avoid rate limits. Configure the update interval when creating your `Chat` instance:
 
@@ -104,9 +109,9 @@ When streaming content that contains GFM tables (e.g. from an LLM), the SDK auto
 
 This happens transparently — no configuration needed.
 
-## Structured streaming chunks (Slack only)
+## Structured streaming chunks
 
-For Slack's native streaming API, you can yield `StreamChunk` objects alongside plain text for rich content:
+For Slack native streams and Linear agent-session streams, you can yield `StreamChunk` objects alongside plain text for rich progress updates:
 
 ```typescript title="lib/bot.ts" lineNumbers
 import type { StreamChunk } from "chat";
@@ -118,6 +123,7 @@ const stream = (async function* () {
     type: "task_update",
     id: "search-1",
     title: "Searching documents",
+    details: "Querying internal docs and ranking the best matches",
     status: "in_progress",
   } satisfies StreamChunk;
 
@@ -127,6 +133,7 @@ const stream = (async function* () {
     type: "task_update",
     id: "search-1",
     title: "Searching documents",
+    details: "Ranked 3 relevant results",
     status: "complete",
     output: "Found 3 results",
   } satisfies StreamChunk;
@@ -142,33 +149,42 @@ await thread.post(stream);
 | Type | Fields | Description |
 |------|--------|-------------|
 | `markdown_text` | `text` | Streamed text content |
-| `task_update` | `id`, `title`, `status`, `output?` | Tool/step progress cards (`pending`, `in_progress`, `complete`, `error`) |
-| `plan_update` | `title` | Plan title updates |
+| `task_update` | `id`, `title`, `status`, `details?`, `output?` | Tool/step progress updates (`pending`, `in_progress`, `complete`, `error`) with optional extra task context |
+| `plan_update` | `title` | Plan title updates on supported platforms |
 
-### Task display mode
+### Streaming with options
 
-Control how `task_update` chunks render in Slack by passing `taskDisplayMode` in stream options:
+Wrap a stream in a `StreamingPlan` to pass platform-specific options through `thread.post()` without dropping down to `adapter.stream()` directly:
 
 ```typescript
-await thread.stream(stream, {
-  taskDisplayMode: "plan", // Group all tasks into a single plan block
+import { StreamingPlan } from "chat";
+
+const planned = new StreamingPlan(stream, {
+  groupTasks: "plan",         // Slack: render task cards as a single grouped block
+  endWith: [feedbackBlock],   // Slack: Block Kit elements appended after stream stops
+  updateIntervalMs: 750,      // Post+edit cadence on supported adapters
 });
+
+await thread.post(planned);
 ```
 
-| Mode | Description |
-|------|-------------|
-| `"timeline"` | Individual task cards shown inline with text (default) |
-| `"plan"` | All tasks grouped into a single plan block |
+| Option | Platform | Description |
+|--------|----------|-------------|
+| `groupTasks` | Slack | `"timeline"` (default) renders task cards inline; `"plan"` groups them into one plan block |
+| `endWith` | Slack | Block Kit elements attached when the stream stops (e.g. retry / feedback buttons) |
+| `updateIntervalMs` | Post+edit adapters | Minimum interval between post+edit cycles in ms (default `500`) |
 
-Adapters without structured chunk support extract text from `markdown_text` chunks and ignore other types.
+Adapters without structured chunk support extract text from `markdown_text` chunks and ignore other types. Slack-only options are silently ignored on other platforms.
 
 ## Stop blocks (Slack only)
 
-When streaming in Slack, you can attach Block Kit elements to the final message using `stopBlocks`. This is useful for adding action buttons after a streamed response completes:
+Use `endWith` on `StreamingPlan` to attach Block Kit elements to the final message. This is useful for adding action buttons after a streamed response completes:
 
 ```typescript title="lib/bot.ts" lineNumbers
-await thread.stream(textStream, {
-  stopBlocks: [
+import { StreamingPlan } from "chat";
+
+const planned = new StreamingPlan(textStream, {
+  endWith: [
     {
       type: "actions",
       elements: [{
@@ -179,8 +195,48 @@ await thread.stream(textStream, {
     },
   ],
 });
+
+await thread.post(planned);
 ```
 
+## Plan API
+
+For step-by-step task progress that lives outside an LLM stream, post a `Plan` directly. `Plan` is a `PostableObject` you can mutate after posting — every mutation re-renders the block in place.
+
+```typescript title="lib/bot.ts" lineNumbers
+import { Plan } from "chat";
+
+const plan = new Plan({ initialMessage: "Researching options..." });
+await thread.post(plan);
+
+const lookup = await plan.addTask({ title: "Look up customer record" });
+// ...do work...
+await plan.updateTask("Found 3 matches");
+
+await plan.addTask({ title: "Summarize findings" });
+await plan.complete({ completeMessage: "Done!" });
+```
+
+By default `updateTask()` mutates the most recent `in_progress` task. Pass `{ id }` to target a specific task — useful when work runs in parallel or out of order:
+
+```typescript
+const fetchTask = await plan.addTask({ title: "Fetch data" });
+const transformTask = await plan.addTask({ title: "Transform" });
+
+// Update a specific task by id, even if it isn't the most recent in_progress one.
+await plan.updateTask({ id: fetchTask.id, output: "Got 42 rows" });
+await plan.updateTask({ id: transformTask.id, status: "complete" });
+```
+
+Adapters that don't support PostableObject editing (e.g. WhatsApp) render the plan as a fallback emoji-list message; the plan still posts, but mutations are no-ops.
+
+| Method | Description |
+|--------|-------------|
+| `addTask({ title, children? })` | Append a new task. The previous in-progress task is auto-completed |
+| `updateTask(input)` | Mutate the current (or `{ id }`-targeted) task's `output`, `status`, or `title` |
+| `complete({ completeMessage })` | Mark all in-progress tasks complete and update the plan title |
+| `reset({ initialMessage })` | Discard all tasks and start fresh with a new initial message — useful when re-using a plan handle for a new run |
+
 ## Streaming with conversation history
 
 Combine message history with streaming for multi-turn AI conversations.

package/docs/subject.mdx

@@ -0,0 +1,53 @@
+---
+title: Message Subject
+description: Fetch the parent resource that a message is about.
+type: guide
+prerequisites:
+  - /docs/handling-events
+related:
+  - /docs/conversation-history
+---
+
+When your bot receives a comment on a Linear issue or GitHub PR, `message.subject` resolves the parent resource so your handler knows what the conversation is about.
+
+## Usage
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onNewMention(async (thread, message) => {
+  const subject = await message.subject;
+
+  if (subject) {
+    await thread.post(
+      `This is about: ${subject.title} (${subject.status})\n${subject.url}`
+    );
+  }
+});
+```
+
+On Linear and GitHub, comment webhooks deliver the comment text but not the parent issue or pull request — `message.subject` fetches it from the platform API on first access. The result is cached on the message instance. On chat platforms (which have no parent-resource concept), or if the API call fails, it returns `null`.
+
+See [`MessageSubject`](/docs/api/message#messagesubject) for the full type shape.
+
+### Platform support
+
+| Platform | `message.subject` returns |
+|----------|--------------------------|
+| Linear | Parent issue (from comment webhooks) |
+| GitHub | Parent issue or PR (from comment webhooks) |
+
+All other platforms return `null`.
+
+## User info
+
+For user profile details, use [`bot.getUser`](/docs/api/chat#getuser):
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onNewMention(async (thread, message) => {
+  const user = await bot.getUser(message.author);
+  if (user) {
+    await thread.post(`Hi ${user.fullName} (${user.email})`);
+  }
+});
+```
+
+For anything beyond `message.subject`, access the platform's typed API client via [`bot.getAdapter(...).client`](/docs/api/chat#getadapter).

package/docs/threads-messages-channels.mdx

@@ -13,6 +13,15 @@ related:
 
 A `Thread` represents a conversation thread on any platform. It provides methods for posting messages, managing subscriptions, and accessing message history.
 
+Thread instances are most often supplied by the SDK to your event handlers. You can also construct one explicitly from a thread ID — useful for cron jobs, workflow steps, or any other context outside an inbound webhook:
+
+```typescript title="lib/bot.ts" lineNumbers
+const thread = bot.thread("slack:C123ABC:1234567890.123456");
+await thread.post("Reminder from a cron job");
+```
+
+For DM-style conversations, use [`bot.openDM(userIdOrAuthor)`](/docs/direct-messages) instead. It resolves the right channel and thread for user ID formats the SDK can infer.
+
 ### Post a message
 
 ```typescript title="lib/bot.ts" lineNumbers
@@ -40,6 +49,33 @@ await thread.unsubscribe();
 const subscribed = await thread.isSubscribed();
 ```
 
+### Participants
+
+Get the unique human participants in a thread. Returns deduplicated authors, excluding all bots. Useful for deciding whether to subscribe based on how many humans are in the conversation.
+
+```typescript title="lib/bot.ts" lineNumbers
+bot.onNewMention(async (thread) => {
+  const participants = await thread.getParticipants();
+  if (participants.length === 1) {
+    await thread.subscribe();
+    await thread.post("I'm here to help!");
+  }
+});
+
+bot.onSubscribedMessage(async (thread) => {
+  const participants = await thread.getParticipants();
+  if (participants.length > 1) {
+    await thread.unsubscribe();
+    return;
+  }
+  // respond...
+});
+```
+
+<Callout type="warn">
+  Each call fetches the full message history to find all participants. On threads with long history this makes multiple API calls to the platform. Consider checking `message.author` against a known set before calling `getParticipants()` on every incoming message.
+</Callout>
+
 ### Typing indicator
 
 ```typescript title="lib/bot.ts"
@@ -144,6 +180,13 @@ interface Author {
 }
 ```
 
+For richer user info (email, avatar), use [`chat.getUser()`](/docs/api/chat#getuser):
+
+```typescript title="lib/bot.ts"
+const user = await bot.getUser(message.author);
+console.log(user?.email); // "alice@company.com"
+```
+
 ### Sent messages
 
 When you post a message, you get back a `SentMessage` with methods to edit, delete, and react:

package/docs/usage.mdx

@@ -34,7 +34,7 @@ bot.onNewMention(async (thread) => {
 ```
 
 <Callout type="info">
-  This example uses Redis. Chat SDK also supports [PostgreSQL](/docs/state/postgres) and [ioredis](/docs/state/ioredis) as production state adapters. See [State Adapters](/docs/state) for all options.
+  This example uses Redis. Chat SDK also supports [PostgreSQL](/adapters/postgres) and [ioredis](/adapters/ioredis) as production state adapters. See [State Adapters](/docs/state) for all options.
 </Callout>
 
 Each adapter factory auto-detects credentials from environment variables (`SLACK_BOT_TOKEN`, `SLACK_SIGNING_SECRET`, `REDIS_URL`, etc.), so you can get started with zero config. Pass explicit values to override.
@@ -89,6 +89,15 @@ await slack.setSuggestedPrompts(channelId, threadTs, [
 ]);
 ```
 
+For typed access to the platform's native API client (Linear, GitHub), use `.client`:
+
+```typescript title="lib/bot.ts" lineNumbers
+const linear = bot.getAdapter("linear").client; // LinearClient
+const github = bot.getAdapter("github").client; // Octokit
+```
+
+See [`getAdapter`](/docs/api/chat#getadapter) for multi-tenant constraints.
+
 ## Webhook routing
 
 The `webhooks` property provides type-safe handlers for each registered adapter. Wire these up to your HTTP framework's routes:
@@ -139,7 +148,7 @@ const bot = Chat.getSingleton();
 Open a DM thread with a user by passing their platform user ID or an `Author` object:
 
 ```typescript title="lib/bot.ts" lineNumbers
-const dm = await bot.openDM("slack:U123ABC");
+const dm = await bot.openDM("U123ABC");
 await dm.post("Hey! Just wanted to follow up on your request.");
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chat",
-  "version": "4.26.0",
+  "version": "4.28.1",
   "description": "Unified chat abstraction for Slack, Teams, Google Chat, and Discord",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,7 +22,8 @@
   },
   "files": [
     "dist",
-    "docs"
+    "docs",
+    "resources"
   ],
   "dependencies": {
     "@workflow/serde": "4.1.0-beta.2",

package/resources/guides/create-a-discord-support-bot-with-nuxt-and-redis.md

@@ -0,0 +1,180 @@
+# Create a Discord support bot with Nuxt and Redis
+
+**Author:** Hayden Bleasel, Ben Sabic
+
+---
+
+You can build a Discord support bot that answers questions with AI, sends interactive cards with buttons, and escalates to human agents on demand by combining Chat SDK, AI SDK, and Nuxt. Chat SDK handles the platform integration (Gateway connection, event parsing, and the Discord API), while AI SDK generates responses using Claude. A Redis state adapter tracks subscribed threads across serverless invocations so conversations stay in context.
+
+This guide will walk you through scaffolding a Nuxt app, configuring a Discord application, wiring up Chat SDK with the Discord adapter, adding AI-powered responses and interactive cards, setting up the Gateway forwarder, and deploying to Vercel.
+
+## Prerequisites
+
+Before you begin, make sure you have:
+
+*   Node.js 18+
+    
+*   [pnpm](https://pnpm.io/) (or npm/yarn)
+    
+*   A Discord server where you have admin access
+    
+*   A Redis instance (local or hosted, such as [Upstash](https://vercel.com/marketplace/upstash))
+    
+*   An [Anthropic API key](https://console.anthropic.com/)
+    
+
+## How it works
+
+Chat SDK is a unified TypeScript SDK for building chatbots across Discord, Slack, Teams, and other platforms. You register event handlers (like `onNewMention` and `onSubscribedMessage`), and the SDK routes incoming events to them. The Discord adapter handles Gateway connection, webhook verification, and the Discord API. The Redis state adapter tracks which threads your bot has subscribed to and manages distributed locking for concurrent message handling.
+
+Discord doesn't push messages to HTTP webhooks like Slack does. Instead, messages arrive through Discord's Gateway WebSocket. The Discord adapter includes a built-in Gateway listener that connects to the WebSocket and forwards events to your webhook endpoint, so the rest of your bot logic looks the same as any other Chat SDK adapter.
+
+When someone @mentions the bot, `onNewMention` fires and posts a support card. Calling `thread.subscribe()` tells the SDK to track that thread, so subsequent messages trigger `onSubscribedMessage` where AI SDK generates a response using Claude.
+
+## Steps
+
+### 1\. Scaffold the project and install dependencies
+
+Create a new Nuxt app and add the Chat SDK, AI SDK, and adapter packages:
+
+`npx nuxi@latest init my-discord-bot cd my-discord-bot pnpm add chat @chat-adapter/discord @chat-adapter/state-redis ai @ai-sdk/anthropic`
+
+The `chat` package is the Chat SDK core. The `@chat-adapter/discord` and `@chat-adapter/state-redis` packages are the [Discord platform adapter](https://chat-sdk.dev/adapters/discord) and [Redis state adapter](https://chat-sdk.dev/adapters/redis). The `ai` and `@ai-sdk/anthropic` packages are used to generate responses with Claude.
+
+### 2\. Create a Discord app
+
+1.  Go to [discord.com/developers/applications](https://discord.com/developers/applications)
+    
+2.  Click **New Application**, give it a name, and click **Create**
+    
+3.  Go to **Bot** in the sidebar and click **Reset Token**. Copy the token, you'll need this as `DISCORD_BOT_TOKEN`
+    
+4.  Under **Privileged Gateway Intents**, enable **Message Content Intent**
+    
+5.  Go to **General Information** and copy the **Application ID** and **Public Key**. You'll need these as `DISCORD_APPLICATION_ID` and `DISCORD_PUBLIC_KEY`
+    
+
+Then set up the Interactions endpoint:
+
+1.  In **General Information**, set the **Interactions Endpoint URL** to [`https://your-domain.com/api/webhooks/discord`](https://your-domain.com/api/webhooks/discord)
+    
+2.  Discord will send a PING to verify the endpoint. You'll need to deploy first or use a tunnel
+    
+
+Then invite the bot to your server:
+
+1.  Go to **OAuth2** in the sidebar
+    
+2.  Under **OAuth2 URL Generator**, select the `bot` scope
+    
+3.  Under **Bot Permissions**, select:
+    
+    *   Send Messages
+        
+    *   Create Public Threads
+        
+    *   Send Messages in Threads
+        
+    *   Read Message History
+        
+    *   Add Reactions
+        
+    *   Use Slash Commands
+        
+4.  Copy the generated URL and open it in your browser to invite the bot
+    
+
+### 3\. Configure environment variables
+
+Create a `.env` file in your project root:
+
+`DISCORD_BOT_TOKEN=your_bot_token DISCORD_PUBLIC_KEY=your_public_key DISCORD_APPLICATION_ID=your_application_id REDIS_URL=redis://localhost:6379 ANTHROPIC_API_KEY=your_anthropic_api_key`
+
+The Discord adapter reads `DISCORD_BOT_TOKEN`, `DISCORD_PUBLIC_KEY`, and `DISCORD_APPLICATION_ID` automatically. The Redis state adapter reads `REDIS_URL`, and AI SDK's Anthropic provider reads `ANTHROPIC_API_KEY`.
+
+### 4\. Create the bot
+
+Create `server/lib/bot.tsx` with a `Chat` instance configured with the Discord adapter. This bot uses AI SDK to answer support questions:
+
+``import { Chat, Card, CardText as Text, Actions, Button, Divider } from "chat"; import { createDiscordAdapter } from "@chat-adapter/discord"; import { createRedisState } from "@chat-adapter/state-redis"; import { generateText } from "ai"; import { anthropic } from "@ai-sdk/anthropic"; export const bot = new Chat({ userName: "support-bot", adapters: { discord: createDiscordAdapter(), }, state: createRedisState(), }); bot.onNewMention(async (thread) => { await thread.subscribe(); await thread.post( <Card title="Support"> <Text>Hey! I'm here to help. Ask your question in this thread and I'll do my best to answer it.</Text> <Divider /> <Actions> <Button id="escalate" style="danger">Escalate to Human</Button> </Actions> </Card> ); }); bot.onSubscribedMessage(async (thread, message) => { await thread.startTyping(); const { text } = await generateText({ model: anthropic("claude-sonnet-4-5-20250514"), system: "You are a friendly support bot. Answer questions concisely. If you don't know the answer, say so and suggest the user click 'Escalate to Human'.", prompt: message.text, }); await thread.post(text); }); bot.onAction("escalate", async (event) => { await event.thread.post( `${event.user.fullName} requested human support. A team member will follow up shortly.` ); });``
+
+The file extension must be `.tsx` (not `.ts`) when using JSX components like `Card` and `Button`. Make sure your `tsconfig.json` has `"jsx": "react-jsx"` and `"jsxImportSource": "chat"`.
+
+`onNewMention` fires when a user @mentions the bot. Calling `thread.subscribe()` tells the SDK to track that thread, so subsequent messages trigger `onSubscribedMessage` where AI SDK generates a response.
+
+### 5\. Create the webhook route
+
+Create a server route that handles incoming Discord webhooks:
+
+``import { bot } from "../lib/bot"; type Platform = keyof typeof bot.webhooks; export default defineEventHandler(async (event) => { const platform = getRouterParam(event, "platform") as Platform; const handler = bot.webhooks[platform]; if (!handler) { throw createError({ statusCode: 404, message: `Unknown platform: ${platform}` }); } const request = toWebRequest(event); return handler(request, { waitUntil: (task) => event.waitUntil(task), }); });``
+
+This creates a `POST /api/webhooks/discord` endpoint. The `waitUntil` option ensures message processing completes after the HTTP response is sent.
+
+### 6\. Set up the Gateway forwarder
+
+Discord doesn't push messages to webhooks like Slack does. Instead, messages arrive through the Gateway WebSocket. The Discord adapter includes a built-in Gateway listener that connects to the WebSocket and forwards events to your webhook endpoint.
+
+Create a route that starts the Gateway listener:
+
+``import { bot } from "../../lib/bot"; export default defineEventHandler(async (event) => { await bot.initialize(); const discord = bot.getAdapter("discord"); if (!discord) { throw createError({ statusCode: 404, message: "Discord adapter not configured" }); } const baseUrl = process.env.NUXT_PUBLIC_SITE_URL || "http://localhost:3000"; const webhookUrl = `${baseUrl}/api/webhooks/discord`; const durationMs = 10 * 60 * 1000; // 10 minutes return discord.startGatewayListener( { waitUntil: (task: Promise<unknown>) => event.waitUntil(task) }, durationMs, undefined, webhookUrl, ); });``
+
+The Gateway listener connects to Discord's WebSocket, receives messages, and forwards them to your webhook endpoint for processing. In production, you'll want a cron job to restart it periodically.
+
+### 7\. Test locally
+
+1.  Start your development server (`pnpm dev`)
+    
+2.  Trigger the Gateway listener by visiting [`http://localhost:3000/api/discord/gateway`](http://localhost:3000/api/discord/gateway) in your browser
+    
+3.  Expose your server with a tunnel (e.g. `ngrok http 3000`)
+    
+4.  Update the **Interactions Endpoint URL** in your Discord app settings to your tunnel URL (e.g. [`https://abc123.ngrok.io/api/webhooks/discord`](https://abc123.ngrok.io/api/webhooks/discord))
+    
+5.  @mention the bot in your Discord server. It should respond with a support card
+    
+6.  Reply in the thread. AI SDK should generate a response
+    
+7.  Click **Escalate to Human**. The bot should post an escalation message
+    
+
+### 8\. Add a cron job for production
+
+The Gateway listener runs for a fixed duration. In production, set up a cron job to restart it automatically. If you're deploying to Vercel, add a `vercel.json`:
+
+`{ "crons": [ { "path": "/api/discord/gateway", "schedule": "*/9 * * * *" } ] }`
+
+This restarts the Gateway listener every 9 minutes, ensuring continuous connectivity. Protect the endpoint with a `CRON_SECRET` environment variable in production.
+
+### 9\. Deploy to Vercel
+
+Deploy your bot to Vercel:
+
+`vercel deploy`
+
+After deployment, set your environment variables in the Vercel dashboard (`DISCORD_BOT_TOKEN`, `DISCORD_PUBLIC_KEY`, `DISCORD_APPLICATION_ID`, `REDIS_URL`, `ANTHROPIC_API_KEY`). Update the **Interactions Endpoint URL** in your Discord app settings to your production URL.
+
+## Troubleshooting
+
+### Bot doesn't respond to mentions
+
+Check that **Message Content Intent** is enabled under **Privileged Gateway Intents** in your Discord app settings. Without it, the bot can't read message content and won't see @mentions. Also confirm the Gateway listener is running by visiting `/api/discord/gateway` or checking that the cron job is configured in production.
+
+### Interactions endpoint verification fails
+
+Discord sends a signed PING request to verify your endpoint. Confirm that `DISCORD_PUBLIC_KEY` matches the value in your Discord app's **General Information** page. A mismatched or missing public key will cause the adapter to reject the verification request.
+
+### Gateway listener disconnects frequently
+
+The listener runs for a fixed duration (10 minutes in this guide) and must be restarted. In production, use the cron job shown in step 8 to restart it every 9 minutes. If disconnections happen sooner, check your server logs for WebSocket errors and verify that `DISCORD_BOT_TOKEN` is valid.
+
+### AI responses are slow or time out
+
+`generateText` blocks until the full response is returned. For long answers, consider switching to streaming with `streamText` and passing the stream directly to [`thread.post`](http://thread.post)`()`. See the [Streaming docs](https://chat-sdk.dev/docs/streaming) for details.
+
+### Redis connection errors
+
+Verify that `REDIS_URL` is reachable from your deployment environment. The state adapter uses Redis for distributed locking, so the bot won't process messages without a working connection.
+
+---
+
+[View full KB sitemap](/kb/sitemap.md)

package/resources/guides/how-to-build-a-slack-bot-with-next-js-and-redis.md

@@ -0,0 +1,134 @@
+# How to build a Slack bot with Next.js and Redis
+
+**Author:** Hayden Bleasel, Ben Sabic
+
+---
+
+You can build a Slack bot that responds to @mentions, tracks thread context, and sends rich interactive messages using Chat SDK with Next.js. Chat SDK handles the platform integration (webhook verification, message parsing, and the Slack API) while a Redis state adapter tracks which threads your bot has subscribed to across serverless invocations. Together with Vercel for deployment, you get a production-ready Slack bot without managing infrastructure or writing platform-specific glue code.
+
+This guide will walk you through scaffolding a Next.js app, configuring a Slack app, wiring up event handlers with Chat SDK, adding interactive cards and buttons, and deploying to Vercel.
+
+## Prerequisites
+
+Before you begin, make sure you have:
+
+*   Node.js 18+
+    
+*   [pnpm](https://pnpm.io/) (or npm/yarn)
+    
+*   A Slack workspace where you can install apps
+    
+*   A Redis instance (local or hosted, such as [Upstash](https://vercel.com/marketplace/upstash))
+    
+
+## How it works
+
+Chat SDK is a unified TypeScript SDK for building chatbots across Slack, Teams, Discord, and other platforms. You register event handlers (like `onNewMention` and `onSubscribedMessage`), and the SDK routes incoming webhooks to them. The Slack adapter handles webhook verification, message parsing, and the Slack API. The Redis state adapter tracks which threads your bot has subscribed to and manages distributed locking for concurrent message handling.
+
+When a user @mentions your bot, `onNewMention` fires. Calling `thread.subscribe()` tells the SDK to track that thread, so subsequent messages trigger `onSubscribedMessage`. This lets your bot maintain conversation context across multiple turns without you managing thread state yourself.
+
+## Steps
+
+### 1\. Scaffold the project and install dependencies
+
+Create a new Next.js app and add the Chat SDK and adapter packages:
+
+`npx create-next-app@latest my-slack-bot --typescript --app cd my-slack-bot pnpm add chat @chat-adapter/slack @chat-adapter/state-redis`
+
+The `chat` package is the Chat SDK core. The `@chat-adapter/slack` and `@chat-adapter/state-redis` packages are the [Slack platform adapter](https://chat-sdk.dev/adapters/slack) and [Redis state adapter](https://chat-sdk.dev/adapters/redis).
+
+### 2\. Create a Slack app
+
+Go to [api.slack.com/apps](https://api.slack.com/apps), click **Create New App**, then **From an app manifest**.
+
+Select your workspace and paste the following manifest:
+
+`display_information: name: My Bot description: A bot built with Chat SDK features: bot_user: display_name: My Bot always_online: true oauth_config: scopes: bot: - app_mentions:read - channels:history - channels:read - chat:write - groups:history - groups:read - im:history - im:read - mpim:history - mpim:read - reactions:read - reactions:write - users:read settings: event_subscriptions: request_url: https://your-domain.com/api/webhooks/slack bot_events: - app_mention - message.channels - message.groups - message.im - message.mpim interactivity: is_enabled: true request_url: https://your-domain.com/api/webhooks/slack org_deploy_enabled: false socket_mode_enabled: false token_rotation_enabled: false`
+
+Replace [`https://your-domain.com/api/webhooks/slack`](https://your-domain.com/api/webhooks/slack) with your deployed webhook URL, then click **Create**.
+
+After creating the app:
+
+1.  Go to **OAuth & Permissions**, click **Install to Workspace**, and copy the **Bot User OAuth Token** (`xoxb-...`). You'll need this as `SLACK_BOT_TOKEN`
+    
+2.  Go to **Basic Information** → **App Credentials** and copy the **Signing Secret**. You'll need this as `SLACK_SIGNING_SECRET`
+    
+
+If you're distributing the app across multiple workspaces via OAuth instead of installing it to one workspace, configure `clientId` and `clientSecret` on the Slack adapter and pass the same redirect URI used during the authorize step into `handleOAuthCallback(request, { redirectUri })` in your callback route.
+
+### 3\. Configure environment variables
+
+Create a `.env.local` file in your project root:
+
+`SLACK_BOT_TOKEN=xoxb-your-bot-token SLACK_SIGNING_SECRET=your-signing-secret REDIS_URL=redis://localhost:6379`
+
+The Slack adapter auto-detects `SLACK_BOT_TOKEN` and `SLACK_SIGNING_SECRET` from your environment, and `createRedisState()` reads `REDIS_URL` automatically.
+
+### 4\. Create the bot
+
+Create `lib/bot.ts` with a `Chat` instance configured with the Slack adapter:
+
+``import { Chat } from "chat"; import { createSlackAdapter } from "@chat-adapter/slack"; import { createRedisState } from "@chat-adapter/state-redis"; export const bot = new Chat({ userName: "mybot", adapters: { slack: createSlackAdapter(), }, state: createRedisState(), }); // Respond when someone @mentions the bot bot.onNewMention(async (thread) => { await thread.subscribe(); await thread.post("Hello! I'm listening to this thread now."); }); // Respond to follow-up messages in subscribed threads bot.onSubscribedMessage(async (thread, message) => { await thread.post(`You said: ${message.text}`); });``
+
+`onNewMention` fires when a user @mentions your bot. Calling `thread.subscribe()` tells the SDK to track that thread, so subsequent messages trigger `onSubscribedMessage`.
+
+### 5\. Create the webhook route
+
+Create a dynamic API route that handles incoming webhooks:
+
+``import { after } from "next/server"; import { bot } from "@/lib/bot"; type Platform = keyof typeof bot.webhooks; export async function POST( request: Request, context: RouteContext<"/api/webhooks/[platform]"> ) { const { platform } = await context.params; const handler = bot.webhooks[platform as Platform]; if (!handler) { return new Response(`Unknown platform: ${platform}`, { status: 404 }); } return handler(request, { waitUntil: (task) => after(() => task), }); }``
+
+This creates a `POST /api/webhooks/slack` endpoint. The `waitUntil` option ensures message processing completes after the HTTP response is sent. This is required on serverless platforms where the function would otherwise terminate before your handlers finish.
+
+### 6\. Test locally
+
+1.  Start your development server (`pnpm dev`)
+    
+2.  Expose it with a tunnel (e.g. `ngrok http 3000`)
+    
+3.  Update the Slack Event Subscriptions **Request URL** to your tunnel URL
+    
+4.  Invite your bot to a Slack channel (`/invite @mybot`)
+    
+5.  @mention the bot. It should respond with "Hello! I'm listening to this thread now."
+    
+6.  Reply in the thread. It should echo your message back
+    
+
+### 7\. Add interactive features
+
+Chat SDK supports rich interactive messages using a JSX-like syntax. Update your bot to send cards with buttons:
+
+``import { Chat, Card, CardText as Text, Actions, Button, Divider } from "chat"; import { createSlackAdapter } from "@chat-adapter/slack"; import { createRedisState } from "@chat-adapter/state-redis"; export const bot = new Chat({ userName: "mybot", adapters: { slack: createSlackAdapter(), }, state: createRedisState(), }); bot.onNewMention(async (thread) => { await thread.subscribe(); await thread.post( <Card title="Welcome!"> <Text>I'm now listening to this thread. Try clicking a button:</Text> <Divider /> <Actions> <Button id="hello" style="primary">Say Hello</Button> <Button id="info">Show Info</Button> </Actions> </Card> ); }); bot.onAction("hello", async (event) => { await event.thread.post(`Hello, ${event.user.fullName}!`); }); bot.onAction("info", async (event) => { await event.thread.post(`You're on ${event.thread.adapter.name}.`); });``
+
+The file extension must be `.tsx` (not `.ts`) when using JSX components like `Card` and `Button`. Make sure your `tsconfig.json` has `"jsx": "react-jsx"` and `"jsxImportSource": "chat"`.
+
+### 8\. Deploy to Vercel
+
+Deploy your bot to Vercel:
+
+`vercel deploy`
+
+After deployment, set your environment variables in the Vercel dashboard (`SLACK_BOT_TOKEN`, `SLACK_SIGNING_SECRET`, `REDIS_URL`). If your manifest used a placeholder URL, update the **Event Subscriptions** and **Interactivity** Request URLs in your [Slack app settings](https://api.slack.com/apps) to your production URL.
+
+## Troubleshooting
+
+### Bot doesn't respond to mentions
+
+Check that your Slack app has the `app_mentions:read` scope and that the **Event Subscriptions** Request URL is correct. Slack sends a challenge request when you first set the URL, so your server must be running and reachable.
+
+### Webhook signature verification fails
+
+Confirm that `SLACK_SIGNING_SECRET` matches the value in your Slack app's **Basic Information** → **App Credentials**. A mismatched or missing signing secret will cause the adapter to reject incoming webhooks.
+
+### Redis connection errors
+
+Verify that `REDIS_URL` is reachable from your deployment environment. If running locally, make sure your Redis instance is started. The state adapter uses Redis for distributed locking, so the bot won't process messages without a working connection.
+
+### Handlers don't run to completion on Vercel
+
+Make sure your webhook route passes `waitUntil` to the handler, as shown in step 5. Without it, serverless functions can terminate before your event handlers finish.
+
+---
+
+[View full KB sitemap](/kb/sitemap.md)