Developer Documentation

Ship embedded support in minutes

Everything you need to integrate Franklin into your SaaS application.

Quick start

Get Franklin up and running in three simple steps.

1Step 1

Install the package

Add Franklin to your project with pnpm.

bash
pnpm add @franklin/sdk-react
2Step 2

Wrap your app

Add Franklin around your application root.

tsx
import { FranklinHelpCenter } from '@franklin/sdk-react';
import '@franklin/sdk-react/style.css';

export function App() {
  return (
    <FranklinHelpCenter
      orgId={process.env.NEXT_PUBLIC_FRANKLIN_ORG_ID}
      sdkKey={process.env.NEXT_PUBLIC_FRANKLIN_SDK_KEY}
    />
  );
}
3Step 3

Configure & launch

Customize Franklin to match your brand and enable features.

tsx
import { FranklinHelpCenter } from '@franklin/sdk-react';

export function App() {
  return (
    <FranklinHelpCenter
      orgId={process.env.NEXT_PUBLIC_FRANKLIN_ORG_ID}
      sdkKey={process.env.NEXT_PUBLIC_FRANKLIN_SDK_KEY}
      shiftTargetSelector="#root"
      theme={{
        accent: '#005689',
        radius: 12,
        fontFamily: 'Inter, sans-serif'
      }}
      features={{
        aiAgent: true,
        knowledgeBase: true,
        caseManagement: true
      }}
    />
  );
}

Architecture overview

Understand how Franklin integrates with your application.

1

Wrapper Component

Franklin wraps your app and manages the layout state.

2

Layout System

CSS transforms smoothly shift your UI when Franklin opens.

3

State Sync

React context keeps sidebar state in sync across your app.

4

API Communication

Secure API calls to Franklin services for AI and knowledge.

5

Analytics

Real-time metrics flow to Franklin so you can monitor adoption.

6

Customization

Theme tokens configure typography, color and radius.

Security model

Franklin is designed with security and privacy at its core. All communication is encrypted, and we never access your data without explicit permission.

  • End-to-end encryption for all data.
  • SOC 2 Type II compliant infrastructure.
  • GDPR and CCPA ready.
  • Zero data retention for AI prompts.
  • API key rotation and granular access controls.
🔒

Ready to start building?

Join the alpha to get API access and start integrating Franklin.