Integrations
Connect OpenSentinel to email, GitHub, Notion, smart home, music, cloud storage, finance, OSINT, calendar, and 14 business adapters.
Overview
OpenSentinel ships with 30+ built-in integrations that connect your AI assistant to the services you already use. Each integration is enabled by adding the relevant API key or configuration to your .env file. If a key is missing, the integration is silently skipped — no errors, no crashes.
| Integration | Category | Key Features |
|---|---|---|
| Communication | Web email client, inbox, send with attachments, AI summarization | |
| Twilio | Communication | SMS, phone calls, voice messages |
| GitHub | Developer | Repos, issues, PRs, code review |
| Notion | Productivity | Pages, databases, search, sync |
| Home Assistant | Smart Home | Device control, automations |
| Spotify | Media | Playback, playlists, search |
| Google Drive | Cloud Storage | Upload, download, search |
| Dropbox | Cloud Storage | Upload, download, sync |
| Finance | Data | Crypto, stocks, currency, alerts |
| Finnhub | Data | Real-time stock quotes, company profiles, market news |
| FRED | Data | Federal Reserve economic data (GDP, CPI, rates) |
| Vision | AI | Screen capture, webcam, OCR |
| Documents | Knowledge | PDF, DOCX, vector search |
| OSINT / Public Records | Intelligence | FEC, SEC EDGAR, IRS 990, USASpending, OpenCorporates |
| Calendar | Productivity | Google Calendar, Outlook, iCal sync |
| Salesforce | CRM | Accounts, contacts, opportunities, campaigns |
| HubSpot | CRM | Marketing automation, contacts, deals |
| Stripe | Payments | Payment processing, subscriptions, invoices |
| Zapier | Automation | Webhook-based integration with 5,000+ apps |
| Jira | Project Mgmt | Issues, sprints, boards, project tracking |
Email (IMAP/SMTP + Web Client)
Full email client built into the dashboard, plus IMAP/SMTP integration with any provider including Gmail, Outlook, Fastmail, and self-hosted mail servers. Browse your inbox, read HTML emails, download and view attachments, compose with attachments, reply, and forward — all from the web UI. Eight dedicated REST API endpoints at /api/email/* power the experience.
Capabilities
- Web email client — full email interface in the dashboard with HTML rendering and attachment support
- Read inbox — fetch recent emails, filter by sender, subject, or date
- Send emails — compose and send with file attachments from the dashboard or API
- Reply & forward — reply to and forward emails directly from the web client
- Attachments — download, view, and attach files with full MIME type support
- AI summarization — get summaries of long threads or daily digests
- Action extraction — automatically identify action items from emails
- 8 REST API endpoints —
/api/email/inbox,/api/email/read,/api/email/send,/api/email/reply,/api/email/forward,/api/email/attachment,/api/email/search,/api/email/folders
Configuration
EMAIL_HOST=imap.gmail.com
EMAIL_USER=you@gmail.com
EMAIL_PASS=your-app-password
EMAIL_SMTP_HOST=smtp.gmail.com
EMAIL_SMTP_PORT=587
Example Usage
import { configure, chatWithTools } from 'opensentinel';
configure({
CLAUDE_API_KEY: process.env.CLAUDE_API_KEY,
EMAIL_HOST: 'imap.gmail.com',
EMAIL_USER: 'you@gmail.com',
EMAIL_PASS: 'your-app-password',
});
// Ask the AI to summarize your inbox
const result = await chatWithTools([
{ role: 'user', content: 'Summarize my unread emails from today' }
]);
console.log(result.text);
Twilio (SMS & Voice)
Send and receive SMS messages, make and receive phone calls, and deliver voice messages. Twilio integration turns OpenSentinel into a phone-capable assistant.
Capabilities
- Send SMS — send text messages to any phone number worldwide
- Receive SMS — incoming messages trigger the AI brain for auto-replies
- Make phone calls — initiate outbound calls with TTS messages
- Receive phone calls — answer inbound calls with AI-generated responses
- Voice messages — record and transcribe voicemail
Configuration
TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_AUTH_TOKEN=your-auth-token
TWILIO_PHONE_NUMBER=+15551234567
https://your-domain.com/api/twilio/webhook. OpenSentinel handles the rest.Example: Send an SMS
You: Send an SMS to +15559876543 saying "Meeting moved to 3pm"
AI: Done. SMS sent to +15559876543.
GitHub
Interact with your GitHub repositories, issues, pull requests, and get AI-powered code reviews. OpenSentinel becomes your intelligent development assistant.
Capabilities
- Repository management — list repos, view files, search code
- Issues — create, update, close, and comment on issues
- Pull requests — create PRs, review diffs, merge
- AI code review — automated code review with suggestions and bug detection
- Webhooks — listen for push, PR, and issue events
Configuration
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Example: AI Code Review
const result = await chatWithTools([
{ role: 'user', content: 'Review the latest PR on dsiemon2/OpenSentinel' }
]);
// Returns detailed code review with line-by-line comments
Notion
Read and write Notion pages, query databases, search across your workspace, and keep content in sync. Great for knowledge management and project tracking.
Capabilities
- Pages — create, read, update, and archive pages
- Databases — query databases with filters and sorts
- Search — full-text search across your entire workspace
- Content sync — keep OpenSentinel's knowledge base in sync with Notion
Configuration
NOTION_TOKEN=ntn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Home Assistant
Control your smart home through natural language. Toggle lights, adjust thermostats, check sensors, and trigger automations — all from a chat message.
Capabilities
- Device control — toggle lights, switches, fans, and covers
- Climate — adjust thermostat temperature, HVAC mode, and fan speed
- Automation triggers — fire Home Assistant automations and scripts
- Entity monitoring — check sensor readings, device states, and battery levels
- Scene activation — activate pre-configured scenes by name
Configuration
HOMEASSISTANT_URL=http://homeassistant.local:8123
HOMEASSISTANT_TOKEN=your-long-lived-access-token
Example
You: Turn off all the lights in the living room and set the thermostat to 72
AI: Done. Turned off 3 lights in the living room. Thermostat set to 72°F.
Spotify
Control music playback, manage playlists, and search the Spotify catalog. OpenSentinel acts as a voice/chat-controlled music assistant.
Capabilities
- Playback control — play, pause, skip, seek, adjust volume
- Playlist management — create playlists, add/remove tracks
- Search — find tracks, albums, artists, and playlists
- Recommendations — get AI-curated song recommendations based on mood or activity
- Now playing — see what's currently playing across devices
Configuration
SPOTIFY_CLIENT_ID=your-spotify-client-id
SPOTIFY_CLIENT_SECRET=your-spotify-client-secret
SPOTIFY_REDIRECT_URI=http://localhost:8030/api/spotify/callback
Cloud Storage
Upload, download, search, and sync files with Google Drive and Dropbox. Access your cloud files directly from chat.
Google Drive
- Upload and download files
- Search by name, type, or content
- Create and manage folders
- Share files and manage permissions
GOOGLE_CLIENT_ID=your-client-id.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=your-client-secret
GOOGLE_REDIRECT_URI=http://localhost:8030/api/google/callback
Dropbox
- Upload and download files
- Search across your Dropbox
- Sync folders with local storage
- Get shared links for files
DROPBOX_ACCESS_TOKEN=your-dropbox-access-token
Finance
Track cryptocurrency prices, stock market data, currency exchange rates, and manage portfolio alerts. OpenSentinel keeps you informed about your financial interests.
Capabilities
- Crypto prices — real-time prices from CoinGecko for thousands of tokens
- Stock data — quotes, historical data, and company info via Yahoo Finance and Alpha Vantage
- Currency exchange — convert between 170+ fiat currencies
- Portfolio tracking — define holdings and get real-time portfolio value
- Price alerts — set alerts for price thresholds on any asset
Configuration
# Optional - CoinGecko works without an API key (rate limited)
COINGECKO_API_KEY=your-api-key
# Optional - for stock data beyond Yahoo Finance
ALPHA_VANTAGE_API_KEY=your-api-key
Example
You: What's the price of Bitcoin and Ethereum? Also check AAPL stock.
AI: BTC: $67,432.18 (+2.3% 24h)
ETH: $3,521.45 (+1.8% 24h)
AAPL: $189.72 (+0.4% today)
You: Alert me if BTC drops below $65,000
AI: Price alert set. I'll notify you when BTC drops below $65,000.
Vision & Documents
Ingest documents into a searchable knowledge base, capture and analyze screen content, and use your webcam for visual AI tasks.
Document Ingestion
OpenSentinel can parse and index documents for RAG-powered retrieval:
- PDF parsing — extract text, tables, and metadata from PDFs
- DOCX parsing — extract content from Word documents
- Text extraction — process TXT, Markdown, CSV, and other text files
- Chunking — intelligent document splitting for optimal vector search
- Knowledge base — vector search across all ingested documents using pgvector
Vision Capabilities
- Screen capture — take screenshots and analyze on-screen content
- Webcam capture — capture images from connected cameras
- Enhanced OCR — extract text from images with AI-powered recognition
- Visual analysis — describe images, identify objects, read handwriting
Example: Knowledge Base
import { configure, chatWithTools } from 'opensentinel';
configure({
CLAUDE_API_KEY: process.env.CLAUDE_API_KEY,
DATABASE_URL: process.env.DATABASE_URL,
OPENAI_API_KEY: process.env.OPENAI_API_KEY, // for embeddings
});
// Ingest a document
const result = await chatWithTools([
{ role: 'user', content: 'Ingest ./docs/handbook.pdf into the knowledge base' }
]);
// Later, query it
const answer = await chatWithTools([
{ role: 'user', content: 'What does the handbook say about vacation policy?' }
]);
EMBEDDING_PROVIDER in your .env file. A PostgreSQL database with pgvector is required for vector storage and search.OSINT & Public Records
Investigate entities, trace financial flows, and map organizational relationships using open-source intelligence and public records.
Capabilities
- FEC Campaign Data — candidate search, committee filings, donor research
- SEC EDGAR — corporate filings (10-K, 10-Q, 8-K), insider trading, company data
- IRS Form 990 — non-profit tax filings, organizational data, revenue analysis
- USASpending — federal contracts, grants, government spending data
- OpenCorporates — corporate entity search across jurisdictions worldwide
- Graph Explorer — D3.js force-directed graph visualization of entity relationships
- Entity Resolution — automatic deduplication and cross-referencing of entities
Calendar Integration
Sync with Google Calendar, Outlook Calendar, and iCal feeds. View upcoming events, create meetings, and receive reminders.
Capabilities
- Google Calendar — list events, create events, RSVP management
- Outlook Calendar — Microsoft Graph API integration, meeting scheduling
- iCal — subscribe to and parse standard iCal/ICS feeds
- Calendar triggers — fire workflows before or after calendar events
Configuration
GOOGLE_CALENDAR_CREDENTIALS=path/to/credentials.json
OUTLOOK_CLIENT_ID=your-client-id
OUTLOOK_CLIENT_SECRET=your-client-secret
Finnhub & FRED (Advanced Finance)
Access real-time market data from Finnhub and macroeconomic indicators from the Federal Reserve Economic Data (FRED) API.
Finnhub
- Real-time stock quotes — latest price, change, volume for US equities
- Company profiles — market cap, industry, IPO date, description
- Market news — latest headlines and sentiment for any ticker
- Financial statements — quarterly/annual income, balance sheet, cash flow
FRED
- Economic series data — GDP, CPI, unemployment, interest rates, and 800,000+ data series
- Historical trends — multi-year economic data for trend analysis
- Category search — browse and search the FRED catalog by topic
Configuration
FINNHUB_API_KEY=your-finnhub-api-key
FRED_API_KEY=your-fred-api-key
Business Adapters (14 Platforms)
Pre-built adapters for popular business platforms. Each adapter normalizes API access and provides a consistent interface for OpenSentinel to interact with.
| Adapter | Category | Key Features |
|---|---|---|
| Salesforce | CRM | Accounts, contacts, opportunities, campaigns |
| HubSpot | CRM | Marketing automation, contacts, deals, workflows |
| Stripe | Payments | Payment processing, subscriptions, invoices |
| Jira | Project Mgmt | Issues, sprints, boards, project tracking |
| Shopify | E-commerce | Products, orders, inventory, analytics |
| QuickBooks | Accounting | Invoices, expenses, reports, payroll |
| Xero | Accounting | Invoices, bank reconciliation, financial reports |
| Mailchimp | Marketing | Campaigns, lists, analytics, automation |
| SendGrid | Transactional email, templates, analytics | |
| Zapier | Automation | Webhook triggers, 5,000+ app connections |
| AWS S3 | Cloud | File storage, bucket management, signed URLs |
| Google Workspace | Productivity | Gmail, Drive, Calendar, Docs API access |
| Microsoft 365 | Productivity | Outlook, Teams, OneDrive, SharePoint |
| Twilio | Communication | SMS, voice, video, WhatsApp Business API |
Built-in ML Algorithms
Five pure TypeScript ML algorithms run locally with zero external dependencies. Used internally for pattern detection, anomaly scoring, and predictive suggestions.
| Algorithm | Use Case | Description |
|---|---|---|
| Isolation Forest | Anomaly detection | Detect unusual patterns in time-series or behavioral data |
| Naive Bayes | Text classification | Categorize messages, tickets, and documents |
| K-Means++ | Clustering | Group similar data points for segmentation and analysis |
| Markov Chain | Sequence prediction | Predict next actions based on behavioral sequences |
| Linear Regression | Forecasting | Trend detection and numerical prediction |
LLM & Embedding Providers
Switch between 8 LLM providers and 3 embedding providers. All modules use the provider registry — setting LLM_PROVIDER routes every AI call through your chosen provider.
LLM Providers (8)
| Provider | Models | Key Features |
|---|---|---|
| Anthropic | Claude Opus, Sonnet, Haiku | Extended thinking, vision, 200K context |
| Google Gemini | Gemini 2.0 Flash, Pro | 1M context, vision, tool use |
| OpenAI | GPT-4o, GPT-4 Turbo | Vision, function calling, 128K context |
| OpenRouter | 200+ models | Multi-model routing, any provider |
| Groq | Llama 3, Mixtral | Ultra-fast inference |
| Mistral | Mistral Large, Medium, Small | Code generation, multilingual |
| Ollama | Any local model | Full privacy, no API calls |
| Custom | Any OpenAI-compatible | Self-hosted or 3rd-party endpoints |
Embedding Providers (3)
| Provider | Models | Dimensions |
|---|---|---|
| OpenAI | text-embedding-3-small, 3-large, ada-002 | 1536 / 3072 |
| HuggingFace | all-MiniLM-L6-v2, all-mpnet-base-v2, BAAI/BGE | 384 / 768 |
| TF-IDF | Built-in (no API needed) | 256 |
RAG Pipeline (6 Techniques)
| Technique | Description | Config |
|---|---|---|
| HyDE | Hypothetical Document Embeddings — generates ideal answer before search | HYDE_ENABLED=true |
| Hybrid Search | Dense (vector) + sparse (keyword) retrieval combined | Always active |
| Re-ranking | LLM scores each result 0-10 for true relevance | RERANK_ENABLED=true |
| Contextual Query | Rewrites queries using conversation context | CONTEXTUAL_QUERY_ENABLED=true |
| Multi-Step RAG | Iterative retrieval with gap detection | MULTISTEP_RAG_ENABLED=true |
| Retrieval Cache | Redis-backed caching (1h TTL, ~60% faster) | RETRIEVAL_CACHE_ENABLED=true |