commune-ai 0.1.5 → 0.1.8

package/README.md

@@ -16,6 +16,26 @@ Build agents that receive emails, reply in threads, access conversation history,
 
 ---
 
+## Table of Contents
+
+- [Install](#install)
+- [How to Setup (Dashboard Steps)](#how-to-setup-dashboard-steps)
+  - [1. Create and Verify Domain](#1-create-and-verify-domain)
+  - [2. Create Inbox](#2-create-inbox)
+  - [3. Create API Key](#3-create-api-key)
+  - [4. Configure Webhook](#4-configure-webhook)
+  - [5. Environment Variables](#5-environment-variables)
+- [Receive emails instantly](#receive-emails-instantly)
+- [Reply in email threads](#reply-in-email-threads)
+- [Access conversation history](#access-conversation-history)
+- [Manage Inboxes Programmatically](#manage-inboxes-programmatically)
+- [How Webhooks Work](#how-webhooks-work)
+- [Listen for Specific Inbox Events](#listen-for-specific-inbox-events)
+- [Semantic Search (Coming Soon)](#semantic-search-coming-soon)
+- [Complete agent example](#complete-agent-example)
+
+---
+
 ## Install
 ```bash
 npm install commune-ai
@@ -71,9 +91,24 @@ COMMUNE_BASE_URL=https://your-self-hosted-api.com
 
 ---
 
-## Receive emails instantly
+## Receive emails at your webhook endpoint
+
+Configure your inbox to send emails to your server, then mount the webhook handler at that endpoint.
+
+### Step 1: Configure webhook URL for your inbox
+
+First, set the webhook URL in your inbox settings (via dashboard or SDK):
+
+```ts
+await client.inboxes.setWebhook(domainId, inboxId, {
+  endpoint: "https://your-server.com/api/emails",  // Your endpoint URL
+  events: ["email.received"],
+});
+```
+
+### Step 2: Mount webhook handler at that URL
 
-Get emails delivered to your agent as structured webhook data.
+Your server must listen at the **exact same URL** you configured:
 
 ```ts
 import "dotenv/config";
@@ -85,8 +120,8 @@ const client = new CommuneClient({
   apiKey: process.env.COMMUNE_API_KEY, // ← From Step 3 above
 });
 
-// Handle incoming emails
-const handler = createWebhookHandler({
+// Create webhook handler to process incoming emails
+const emailHandler = createWebhookHandler({
   onEvent: async (message, context) => {
     console.log(`📧 New email: ${message.content}`);
 
@@ -110,9 +145,11 @@ const handler = createWebhookHandler({
   },
 });
 
-// Set up webhook endpoint
+// Set up your server
 const app = express();
-app.post("/webhook", express.raw({ type: "*/*" }), handler);
+
+// This URL must match what you configured in Step 1
+app.post("/api/emails", express.raw({ type: "*/*" }), emailHandler);
 
 // Health check
 app.get("/health", (req, res) => res.json({ status: "ok" }));
@@ -123,6 +160,12 @@ app.listen(3000, () => {
 });
 ```
 
+**Complete flow:**
+1. Email arrives at your inbox
+2. Resend sends webhook to Commune backend
+3. Commune backend sends email to your configured endpoint (`/api/emails`)
+4. Your `emailHandler` processes the email and replies
+
 **Email structure:**
 ```ts
 interface UnifiedMessage {
@@ -157,7 +200,8 @@ const client = new CommuneClient({
   apiKey: process.env.COMMUNE_API_KEY,
 });
 
-const handler = createWebhookHandler({
+// Create webhook handler
+const emailHandler = createWebhookHandler({
   onEvent: async (message, context) => {
     const sender = message.participants.find(p => p.role === "sender")?.identity;
     if (!sender) return;
@@ -174,9 +218,15 @@ const handler = createWebhookHandler({
   },
 });
 
+// Set up your server
 const app = express();
-app.post("/webhook", express.raw({ type: "*/*" }), handler);
-app.listen(3000);
+
+// Mount handler at your webhook endpoint
+app.post("/api/emails", express.raw({ type: "*/*" }), emailHandler);
+
+app.listen(3000, () => {
+  console.log("Agent running on port 3000");
+});
 ```
 
 ---
@@ -304,14 +354,33 @@ await client.inboxes.remove(domainId, inboxId);
 
 ---
 
-## Listen for Specific Inbox Events
+## How Webhooks Work
+
+**Understanding the webhook flow:**
 
-Route incoming emails based on which inbox received them:
+1. **Resend Webhooks** → When you verify a domain, the backend creates a webhook at Resend (email service) that points to the Commune backend
+2. **Commune Backend** → Processes the webhook from Resend and looks up inbox configurations
+3. **Your Webhook Endpoint** → If an inbox has a webhook URL set, Commune sends an HTTP POST to your endpoint
+
+```typescript
+// Webhook flow: Resend → Commune Backend → Your Server
+// Your server uses createWebhookHandler to process webhooks from Commune
+```
+
+## Listen for specific inbox events
+
+Route incoming emails based on which inbox received them. Set up different webhook endpoints for different inboxes.
 
 ```ts
-import { createWebhookHandler } from "commune-ai";
+import express from "express";
+import { CommuneClient, createWebhookHandler } from "commune-ai";
 
-const handler = createWebhookHandler({
+const client = new CommuneClient({
+  apiKey: process.env.COMMUNE_API_KEY,
+});
+
+// Create webhook handler for routing
+const emailRouter = createWebhookHandler({
   onEvent: async (message, context) => {
     const { inboxId, inboxAddress } = context.payload;
 
@@ -329,6 +398,18 @@ const handler = createWebhookHandler({
   },
 });
 
+// Set up your server
+const app = express();
+
+// Mount the same handler at different endpoints for different inboxes
+app.post("/api/support", express.raw({ type: "*/*" }), emailRouter);    // For support inbox
+app.post("/api/sales", express.raw({ type: "*/*" }), emailRouter);      // For sales inbox
+app.post("/api/general", express.raw({ type: "*/*" }), emailRouter);    // For general inbox
+
+app.listen(3000, () => {
+  console.log("Agent running with multiple inbox endpoints");
+});
+
 // Example handlers
 async function handleSupportEmail(message: any, context: any) {
   const sender = message.participants.find(p => p.role === "sender")?.identity;
@@ -408,7 +489,7 @@ const client = new CommuneClient({
   apiKey: process.env.COMMUNE_API_KEY,
 });
 
-const handler = createWebhookHandler({
+const emailProcessor = createWebhookHandler({
   onEvent: async (message, context) => {
     const sender = message.participants.find(p => p.role === "sender")?.identity;
     if (!sender) return;
@@ -452,8 +533,11 @@ const handler = createWebhookHandler({
   },
 });
 
+// Set up your server
 const app = express();
-app.post("/webhook", express.raw({ type: "*/*" }), handler);
+
+// Mount webhook handler at your endpoint
+app.post("/api/emails", express.raw({ type: "*/*" }), emailProcessor);
 
 // Health check endpoint
 app.get("/health", (req, res) => res.json({ status: "ok" }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.1.5",
+  "version": "0.1.8",
   "description": "Email infrastructure for AI agents - webhooks, threads, history, and semantic search",
   "type": "module",
   "main": "dist/index.js",