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.

💡
Enable what you need. Every integration is optional. OpenSentinel gracefully skips any service that lacks credentials. Start with one or two integrations and add more as needed.
IntegrationCategoryKey Features
EmailCommunicationWeb email client, inbox, send with attachments, AI summarization
TwilioCommunicationSMS, phone calls, voice messages
GitHubDeveloperRepos, issues, PRs, code review
NotionProductivityPages, databases, search, sync
Home AssistantSmart HomeDevice control, automations
SpotifyMediaPlayback, playlists, search
Google DriveCloud StorageUpload, download, search
DropboxCloud StorageUpload, download, sync
FinanceDataCrypto, stocks, currency, alerts
FinnhubDataReal-time stock quotes, company profiles, market news
FREDDataFederal Reserve economic data (GDP, CPI, rates)
VisionAIScreen capture, webcam, OCR
DocumentsKnowledgePDF, DOCX, vector search
OSINT / Public RecordsIntelligenceFEC, SEC EDGAR, IRS 990, USASpending, OpenCorporates
CalendarProductivityGoogle Calendar, Outlook, iCal sync
SalesforceCRMAccounts, contacts, opportunities, campaigns
HubSpotCRMMarketing automation, contacts, deals
StripePaymentsPayment processing, subscriptions, invoices
ZapierAutomationWebhook-based integration with 5,000+ apps
JiraProject MgmtIssues, 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

.env
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

TypeScript
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

.env
TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_AUTH_TOKEN=your-auth-token
TWILIO_PHONE_NUMBER=+15551234567
ℹ️
Webhook setup. For receiving SMS and phone calls, configure your Twilio phone number to forward webhooks to https://your-domain.com/api/twilio/webhook. OpenSentinel handles the rest.

Example: Send an SMS

Chat
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

.env
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Example: AI Code Review

TypeScript
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

.env
NOTION_TOKEN=ntn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
💡
Notion integration setup. Create an internal integration at notion.so/my-integrations, then share the pages or databases you want OpenSentinel to access with the integration.

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

.env
HOMEASSISTANT_URL=http://homeassistant.local:8123
HOMEASSISTANT_TOKEN=your-long-lived-access-token

Example

Chat
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

.env
SPOTIFY_CLIENT_ID=your-spotify-client-id
SPOTIFY_CLIENT_SECRET=your-spotify-client-secret
SPOTIFY_REDIRECT_URI=http://localhost:8030/api/spotify/callback
ℹ️
Spotify Premium required. Playback control features require a Spotify Premium account. Search and playlist management work with free accounts.

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
.env
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
.env
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

.env
# 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

Chat
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

TypeScript
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 providers. Document ingestion supports 3 embedding providers: OpenAI (text-embedding-3-small), HuggingFace (sentence-transformers), and TF-IDF (zero-API fallback). Set 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

.env
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

.env
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.

AdapterCategoryKey Features
SalesforceCRMAccounts, contacts, opportunities, campaigns
HubSpotCRMMarketing automation, contacts, deals, workflows
StripePaymentsPayment processing, subscriptions, invoices
JiraProject MgmtIssues, sprints, boards, project tracking
ShopifyE-commerceProducts, orders, inventory, analytics
QuickBooksAccountingInvoices, expenses, reports, payroll
XeroAccountingInvoices, bank reconciliation, financial reports
MailchimpMarketingCampaigns, lists, analytics, automation
SendGridEmailTransactional email, templates, analytics
ZapierAutomationWebhook triggers, 5,000+ app connections
AWS S3CloudFile storage, bucket management, signed URLs
Google WorkspaceProductivityGmail, Drive, Calendar, Docs API access
Microsoft 365ProductivityOutlook, Teams, OneDrive, SharePoint
TwilioCommunicationSMS, 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.

AlgorithmUse CaseDescription
Isolation ForestAnomaly detectionDetect unusual patterns in time-series or behavioral data
Naive BayesText classificationCategorize messages, tickets, and documents
K-Means++ClusteringGroup similar data points for segmentation and analysis
Markov ChainSequence predictionPredict next actions based on behavioral sequences
Linear RegressionForecastingTrend 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)

ProviderModelsKey Features
AnthropicClaude Opus, Sonnet, HaikuExtended thinking, vision, 200K context
Google GeminiGemini 2.0 Flash, Pro1M context, vision, tool use
OpenAIGPT-4o, GPT-4 TurboVision, function calling, 128K context
OpenRouter200+ modelsMulti-model routing, any provider
GroqLlama 3, MixtralUltra-fast inference
MistralMistral Large, Medium, SmallCode generation, multilingual
OllamaAny local modelFull privacy, no API calls
CustomAny OpenAI-compatibleSelf-hosted or 3rd-party endpoints

Embedding Providers (3)

ProviderModelsDimensions
OpenAItext-embedding-3-small, 3-large, ada-0021536 / 3072
HuggingFaceall-MiniLM-L6-v2, all-mpnet-base-v2, BAAI/BGE384 / 768
TF-IDFBuilt-in (no API needed)256

RAG Pipeline (6 Techniques)

TechniqueDescriptionConfig
HyDEHypothetical Document Embeddings — generates ideal answer before searchHYDE_ENABLED=true
Hybrid SearchDense (vector) + sparse (keyword) retrieval combinedAlways active
Re-rankingLLM scores each result 0-10 for true relevanceRERANK_ENABLED=true
Contextual QueryRewrites queries using conversation contextCONTEXTUAL_QUERY_ENABLED=true
Multi-Step RAGIterative retrieval with gap detectionMULTISTEP_RAG_ENABLED=true
Retrieval CacheRedis-backed caching (1h TTL, ~60% faster)RETRIEVAL_CACHE_ENABLED=true