Getting Started
Set up SupportFlow in your app in 5 minutes. This guide covers everything from account creation to your first support widget.
1Create Your Account
Start your free 14-day trial (no credit card required).
Create Account2Create Your App
After signing in, create a new app from the admin dashboard. Each app has its own:
- Knowledge base
- Support issues
- Help content
- Branding
Tip: Your app slug becomes part of your support URL. For example, if your slug is myapp, your support page will be at support.yourdomain.com/myapp
3Configure JWT Secret
To authenticate users from your app, you need to share a JWT secret between SupportFlow and your backend.
Generate a secret
Generate a secure random string (at least 32 characters):
openssl rand -base64 32Add to SupportFlow
Go to Settings in your app's admin panel and paste the secret in the JWT Secret field.
Add to your backend
Add the same secret to your app's environment:
SUPPORT_JWT_SECRET=your-generated-secret-hereSee the JWT Integration Guide for detailed instructions on signing tokens.
4Install the Widget
Add the SupportFlow widget to your app. Choose your framework:
React / Next.js
import { SupportWidget } from '@supportflow/react'
function App() {
const user = useAuth() // your auth hook
return (
<>
{/* Your app content */}
{user && (
<SupportWidget
appId="your-app-slug"
user={{
id: user.id,
email: user.email,
name: user.name,
}}
token={generateToken(user)} // JWT signed with shared secret
/>
)}
</>
)
}Vanilla JavaScript
<script src="https://cdn.supportflow.dev/widget.js"></script>
<script>
SupportFlow.init({
appId: 'your-app-slug',
user: {
id: 'user-123',
email: 'user@example.com',
},
token: 'jwt-token-here'
})
</script>See the Widget Guide for all configuration options.