Opencom - Open Source Customer Messaging

Documentation

Get started with Opencom

Everything you need to deploy and customize your own customer messaging platform.

Quick Start Guide

Get up and running with Opencom in under 5 minutes.

Self-Hosting

Deploy Opencom on your own infrastructure with Convex.

Widget Integration

Embed the chat widget in your website with a single script tag.

Native SDKs

React Native, iOS (Swift), and Android (Kotlin) SDKs.

AI Agent Setup

Configure the AI agent with OpenAI or Anthropic models.

API Reference

Explore the complete API and Convex function docs.

Architecture

Understand the monorepo structure and tech stack.

Contributing Guide

Learn how to contribute to the project.

Quick Start

Get Opencom running locally in a few steps.

1. Clone the repository

git clone https://github.com/opencom-org/opencom.git

2. Install dependencies

cd opencom && pnpm install

3. Set up Convex

npx convex dev

This will prompt you to create a Convex account and project.

4. Seed demo data (optional)

pnpm --filter @opencom/convex seed

Populates conversations, tickets, tours, articles, and more.

5. Start the development server

pnpm dev

6. Open in browser

Visit http://localhost:3000 to see the dashboard with all features: inbox, tickets, tours, knowledge hub, outbound, surveys, campaigns, checklists, tooltips, reports, and more.

Self-Hosting Options

Deploy Opencom on your preferred infrastructure.

Convex Cloud

Use Convex's managed cloud for automatic scaling and zero server management.

• Free tier available
• Automatic scaling
• Built-in real-time sync

Self-Hosted Convex

Run Convex on your own infrastructure for complete data sovereignty.

• Full data control
• Custom deployment
• Enterprise support available

Alpha Notice

Opencom is currently in alpha. While the core features are functional, we don't recommend using it in production yet. We're actively working on stability, performance, and documentation.

Widget Integration

Add the Opencom widget to your website with a single script tag.

<script
  src="https://your-domain.com/widget.js"
  data-workspace-id="YOUR_WORKSPACE_ID"
  async
></script>

The widget includes 6 tabs: Home, Messages, Help Center, Tours, Tasks, and Tickets. Customize colors, greeting text, and behavior from the Settings page.

Native SDKs

Integrate Opencom into your mobile apps.

React Native

pnpm add @opencom/react-native-sdk

Expo plugin included for easy setup.

iOS (Swift)

.package(url: "...OpencomSDK")

Swift Package Manager or CocoaPods.

Android (Kotlin)

implementation("com.opencom:sdk")

Gradle dependency with Compose UI.

AI Agent

Automate responses using your knowledge base and LLM providers.

Supported Providers

OpenAI

GPT-4o, GPT-4o Mini

Anthropic

Claude 3 Haiku, Claude 3.5 Sonnet

How It Works

1. Customer asks a question in the widget
2. AI searches your knowledge base articles
3. LLM generates a response with confidence scoring
4. High-confidence replies sent automatically; low-confidence handed off to a human

Architecture

A monorepo with apps, packages, and shared tooling.

opencom/
├── apps/
│   ├── web/          # Next.js admin dashboard
│   ├── mobile/       # Expo mobile admin app
│   ├── widget/       # Vite embeddable widget
│   └── landing/      # This website
├── packages/
│   ├── convex/       # Backend (Convex functions, schema)
│   ├── ui/           # Shared component library (shadcn/ui)
│   ├── react-native-sdk/
│   ├── ios-sdk/      # Swift SDK
│   └── android-sdk/  # Kotlin SDK
└── docs/             # Architecture & security docs

Convex

Real-time backend

Next.js

Web dashboard

Expo

Mobile apps

Need help?

Check out our GitHub discussions or open an issue.