Skip to main content

​
Overview

OpenSight integrates with several third-party services to provide authentication, payments, notifications, and AI capabilities. All integrations are configured via environment variables.

​
Authentication

OpenSight supports multiple authentication methods configured in apps/api/src/config/passport.ts.

​
GitHub OAuth

Allow users to sign in with their GitHub account. Configuration (.env.example:7-8): 
GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret
OAuth Flow:
  1. User clicks “Sign in with GitHub”
  2. Redirects to GET /auth/github
  3. GitHub callback to GET /auth/github/callback
  4. User created or linked in database
Implementation (apps/api/src/config/passport.ts:130-152): 
passport.use(
  new GitHubStrategy(
    {
      clientID: env.GITHUB_CLIENT_ID,
      clientSecret: env.GITHUB_CLIENT_SECRET,
      callbackURL: env.GITHUB_CALLBACK_URL || `${env.FRONTEND_URL}/auth/github/callback`,
    },
    async (accessToken, refreshToken, profile, done) => {
      const user = await findOrCreateGithubUser(profile);
      return done(null, user);
    }
  )
);
GitHub OAuth emails are automatically verified. Users authenticated via GitHub have email_verified: true.

​
Google OAuth

Allow users to sign in with their Google account. Configuration (.env.example:9-10): 
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
OAuth Flow:
  1. User clicks “Sign in with Google”
  2. Redirects to GET /auth/google (scopes: profile, email)
  3. Google callback to GET /auth/google/callback
  4. User created or linked in database
Token-based Flow: For mobile/SPA apps, use the token endpoint: 
POST /auth/google/token
Content-Type: application/json

{
  "idToken": "google_id_token_from_client"
}
Implementation (apps/api/src/config/passport.ts:152-170): 
passport.use(
  new GoogleStrategy(
    {
      clientID: env.GOOGLE_CLIENT_ID,
      clientSecret: env.GOOGLE_CLIENT_SECRET,
      callbackURL: env.GOOGLE_CALLBACK_URL || `${env.FRONTEND_URL}/auth/google/callback`,
    },
    async (accessToken, refreshToken, profile, done) => {
      const user = await findOrCreateGoogleUser(profile);
      return done(null, user);
    }
  )
);
Google OAuth implementation uses the google-auth-library package for token verification in the /auth/google/token endpoint.

​
Local Authentication

Traditional email/password authentication using Passport Local Strategy. Configuration (.env.example:5-6): 
JWT_SECRET=generate-a-64-char-random-string
JWT_REFRESH_SECRET=generate-another-64-char-random-string
User Model (packages/shared/src/types/user.ts): 
export interface User {
  id: string;
  email: string;
  full_name: string;
  avatar_url: string | null;
  email_verified: boolean;
  github_id: string | null;  // Linked GitHub account
  google_id: string | null;  // Linked Google account
  stripe_customer_id: string | null;
  stripe_subscription_id: string | null;
  plan_id: PlanId;
  created_at: string;
  updated_at: string;
}
JWT secrets must be at least 32 characters in production. Use a cryptographically secure random string generator.

​
Payment Processing

​
Stripe

Stripe handles all subscription billing and payment processing. Configuration (.env.example:12-17): 
STRIPE_SECRET_KEY=sk_test_...
STRIPE_WEBHOOK_SECRET=whsec_...
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_...
STRIPE_STARTER_PRICE_ID=price_...
STRIPE_GROWTH_PRICE_ID=price_...
Stripe Client (apps/api/src/config/stripe.ts): 
import Stripe from 'stripe';
import { env } from './env.js';

export const stripe = new Stripe(env.STRIPE_SECRET_KEY || '', {
  apiVersion: '2023-10-16',
});
Webhook Handler (apps/api/src/routes/webhook.routes.ts): 
POST /api/webhooks/stripe
Handles Stripe events:
  • customer.subscription.created
  • customer.subscription.updated
  • customer.subscription.deleted
  • invoice.payment_succeeded
  • invoice.payment_failed
Stripe webhooks must be configured in your Stripe Dashboard to point to https://your-domain.com/api/webhooks/stripe
User Subscription Data: Each user has Stripe fields:
  • stripe_customer_id: Stripe Customer ID
  • stripe_subscription_id: Active subscription ID
  • plan_id: Current plan (free, starter, growth)

​
Email Services

​
Resend

Resend powers all transactional emails. Configuration (.env.example:19-21): 
RESEND_API_KEY=re_...
EMAIL_FROM=[email protected]
Email Functions (apps/api/src/config/email.ts): 
import { Resend } from 'resend';
import { env } from './env.js';

export const resend = new Resend(env.RESEND_API_KEY || '');

// Send verification email
export async function sendVerificationEmail(
  email: string,
  verificationUrl: string
): Promise<void>

// Send password reset
export async function sendPasswordResetEmail(
  email: string,
  resetUrl: string
): Promise<void>

// Send alert digest
export async function sendAlertDigest(
  email: string,
  alerts: any[]
): Promise<void>
Email Types:
  1. Verification Email: Sent on user registration
  2. Password Reset: Sent when user requests password reset
  3. Alert Digest: Weekly/daily notification summaries
Email alerts are sent based on user plan and notification preferences. See Plans & Pricing for details.

​
Caching & Job Queue

​
Upstash Redis

Upstash provides HTTP-based Redis for caching and rate limiting. Configuration (.env.example:23-25): 
UPSTASH_REDIS_REST_URL=https://your-upstash-url.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-upstash-token
Redis Client (apps/api/src/config/redis.ts): 
import { Redis } from '@upstash/redis';
import { env } from './env.js';

export const redis = new Redis({
  url: env.UPSTASH_REDIS_REST_URL,
  token: env.UPSTASH_REDIS_REST_TOKEN,
});
Job Processing: OpenSight includes a simple in-process job runner: 
export async function runJob<T>(
  jobName: string,
  data: T,
  processor: (data: T) => Promise<any>,
  options: JobOptions = {}
): Promise<any>
This replaces BullMQ for simple, single-server deployments. Redis is used via HTTP REST API instead of TCP connections.

​
AI Engine APIs

OpenSight integrates with multiple AI engines for visibility tracking.

​
OpenAI

Configuration (.env.example:27-28): 
OPENAI_API_KEY=sk-...
Used for:
  • ChatGPT visibility tracking
  • Content analysis
  • Prompt evaluation

​
Perplexity

Configuration (.env.example:29): 
PERPLEXITY_API_KEY=pplx-...
Used for:
  • Perplexity AI visibility tracking
  • Answer analysis
Configuration (.env.example:30): 
SERPER_API_KEY=...
Used for:
  • Google AI Overviews tracking
  • SERP analysis
  • Competitor monitoring

ChatGPT

Available on all plans

Perplexity

Starter and Growth plans

Google AIO

Starter and Growth plans

​
File Uploads

​
UploadThing

Configuration (.env.example:32-34): 
UPLOADTHING_SECRET=sk_live_...
UPLOADTHING_APP_ID=...
Used for:
  • Brand logo uploads
  • User avatar uploads
  • Report attachments

​
Error Tracking

​
Sentry (Optional)

Configuration (.env.example:36-38): 
SENTRY_DSN=https://[email protected]/...
NEXT_PUBLIC_SENTRY_DSN=https://[email protected]/...
Sentry is optional but recommended for production deployments. It provides error tracking and performance monitoring.

​
Webhooks

Users on the Growth plan can configure custom webhooks for real-time notifications. Webhook Configuration (apps/api/src/services/notification.service.ts): 
interface NotificationSettings {
  webhookUrl?: string;
  // ...
}
Webhook Delivery (apps/api/src/jobs/alert-checker.ts): 
async function sendWebhookNotification(
  webhookUrl: string,
  payload: WebhookPayload
): Promise<void> {
  const response = await fetch(webhookUrl, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(payload),
  });
}
Webhook Events:
  • Visibility drops
  • New competitor mentions
  • Sentiment shifts
  • New brand mentions
Webhooks are only available on the Growth plan. See Plans & Pricing for upgrade options.

​
Feature Flags

Configuration (.env.example:40-42): 
ENABLE_CONTENT_SCORING=true
ENABLE_WEBHOOKS=true
Feature flags allow you to toggle features without code changes:
  • ENABLE_CONTENT_SCORING: Enable/disable content scoring API
  • ENABLE_WEBHOOKS: Enable/disable webhook notifications

​
Environment Variables Summary

ServiceRequiredEnvironment Variables
Database✅ YesDATABASE_URL
Auth✅ YesJWT_SECRET, JWT_REFRESH_SECRET
GitHub OAuth❌ OptionalGITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET
Google OAuth❌ OptionalGOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
Stripe❌ OptionalSTRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET, STRIPE_*_PRICE_ID
Resend❌ OptionalRESEND_API_KEY
Upstash Redis✅ YesUPSTASH_REDIS_REST_URL, UPSTASH_REDIS_REST_TOKEN
OpenAI❌ OptionalOPENAI_API_KEY
Perplexity❌ OptionalPERPLEXITY_API_KEY
Serper❌ OptionalSERPER_API_KEY
UploadThing❌ OptionalUPLOADTHING_SECRET, UPLOADTHING_APP_ID
Sentry❌ OptionalSENTRY_DSN, NEXT_PUBLIC_SENTRY_DSN

Plans & Pricing

View integration availability by subscription tier

Admin Panel

Manage platform integrations from admin dashboard

Build docs developers (and LLMs) love

Get started for freeTalk to us