chat-adapter-zoom

Zoom Team Chat adapter for the chat SDK.

npm install chat-adapter-zoom chat

import { Chat } from "chat";
import { createZoomAdapter } from "chat-adapter-zoom";

const bot = new Chat({
  adapters: { zoom: createZoomAdapter() },
  state,
});

bot.onNewMention(async (thread, message) => {
  await thread.subscribe();
  await thread.post(`Hi ${message.author.userName}!`);
});

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post(`You said: ${message.text}`);
});

createZoomAdapter() reads credentials from environment variables by default. You can also pass them explicitly.

All five credential fields are required. A ValidationError is thrown at startup if any are missing.

Wire up the webhook route in your framework. With Next.js App Router:

// app/api/webhooks/zoom/route.ts
import { after } from "next/server";
import { bot } from "@/lib/bot";

export async function POST(request: Request): Promise<Response> {
  return bot.webhooks.zoom(request, {
    waitUntil: (task) => after(() => task),
  });
}

Set the Bot Endpoint URL in your Zoom Marketplace app to https://your-deployment/api/webhooks/zoom.

The adapter handles Zoom's CRC URL validation challenge automatically — no extra route needed.

1. Create a General App (Admin-managed) at marketplace.zoom.us
2. Enable Team Chat Subscription under Features
3. Copy credentials to your environment:
   • Client ID / Secret from App Credentials
   • Account ID from App Credentials
   • Bot JID from Team Chat Subscription
   • Webhook Secret Token from Features → Access → Token
4. Add scope: imchat:bot
5. Set Bot Endpoint URL to your webhook route

ZOOM_CLIENT_ID=your_client_id
ZOOM_CLIENT_SECRET=your_client_secret
ZOOM_ACCOUNT_ID=your_account_id
ZOOM_ROBOT_JID=your_robot_jid@xmpp.zoom.us
ZOOM_WEBHOOK_SECRET_TOKEN=your_webhook_secret_token

• Webhook verification — CRC URL validation (HMAC-SHA256) + per-request signature verification with timing-safe comparison and 5-minute replay protection
• Inbound events — bot_notification and team_chat.app_mention normalized to SDK Message
• Outbound — thread.post(), thread.edit(), thread.delete() via /v2/im/chat/messages
• Markdown — bidirectional Zoom markdown ↔ mdast (bold, italic, code, links, lists, blockquotes, inline code)
• Emoji — Unicode rendering via convertEmojiPlaceholders
• DM detection — isDM(threadId) based on JID suffix
• Auth — S2S OAuth client_credentials with automatic token caching and 60-second early-expiry refresh

A full Next.js example is in examples/nextjs/.

MIT — see LICENSE.