Onboarding Feature¶
Overview¶
The Onboarding feature (/onboarding) provides a guided setup wizard for new users to configure their ConnectGain account. It ensures users complete essential setup steps including email verification, subscription selection, and optional channel configuration before accessing the platform. The onboarding process includes visual progress tracking and allows users to skip optional steps.
Features¶
1. Onboarding Steps¶
Step 1: Email Verification - Verify email address - Email verification check - Verification status indicator - Verification instructions - Cannot proceed without verification
Step 2: Subscription - Choose subscription plan - Plan selection - Trial period information - Plan comparison - Subscribe button - Redirect to Stripe checkout
Step 3: Channel Setup - Connect messaging channels - Channel connection - Channel configuration - Skip option available - Optional step
2. Progress Tracking¶
Visual Progress: - Progress indicators - Step completion checkmarks - Current step highlighting - Progress bar
Step Status: - Completed steps (green checkmark) - Current step (blue circle) - Pending steps (gray circle)
2. Email Verification Step¶
Verification Features: - Email verification required - Cannot proceed without verification - Verification email sent automatically - Resend verification option - Verification status tracking
Verification Process: 1. User signs up 2. Verification email sent 3. User clicks verification link 4. Email verified 5. Can proceed to next step
3. Subscription Step¶
Subscription Features: - Redirected to pricing page - Must select subscription plan - Trial period available - Cannot proceed without subscription - Subscription activation required
Subscription Process: 1. After email verification 2. Redirected to pricing 3. Select plan 4. Complete checkout 5. Subscription activated 6. Can proceed to next step
3. Channel Setup¶
Connected Channels: - Display connected channels - Channel cards - Channel status - Channel actions (toggle, delete)
Add Channels: - Connect new channels - Add channel dialog - Channel type selection - Channel configuration - OAuth integration (Facebook, Instagram) - QR code authentication (WhatsApp Lite)
Skip Option: - Skip channel setup - Skip button - Optional step indication - Continue without channels - Can add channels later in Settings
4. Onboarding Completion¶
Finish Setup: - Complete onboarding - Finish button - Onboarding completion tracking - Redirect to dashboard
Skip for Now: - Skip remaining steps - Skip button - Later completion option - Access platform immediately
Use Cases¶
Use Case 1: New User Onboarding¶
Scenario: New user signs up and completes onboarding.
Steps: 1. User signs up with email 2. Receives verification email 3. Clicks verification link 4. Email verified 5. Redirected to pricing page 6. Selects subscription plan 7. Completes checkout 8. Redirected to onboarding page 9. Optionally connects channel 10. Clicks "Skip" or "Finish" 11. Access to platform granted
Expected Outcome: User successfully onboarded and can access platform.
Use Case 2: Skip Channel Setup¶
Scenario: User wants to skip channel setup and add later.
Steps: 1. Complete email verification 2. Complete subscription 3. Reach channel setup step 4. Click "Skip for Now" 5. Onboarding marked complete 6. Access to platform granted 7. Can add channels later in Settings
Expected Outcome: Onboarding completed without channels, can add later.
Use Case 3: Connect Channel During Onboarding¶
Scenario: User wants to connect channel immediately.
Steps: 1. Complete email verification 2. Complete subscription 3. Reach channel setup step 4. Click "Add Channel" 5. Select channel type 6. Complete channel configuration 7. Channel connected 8. Click "Finish" 9. Access to platform granted
Expected Outcome: Channel connected and onboarding completed.
API Integration¶
Check Onboarding Status¶
Endpoint: GET /rest/v1/profiles?id=eq.{user_id}
Response:
Mark Onboarding Complete¶
Endpoint: PATCH /rest/v1/profiles?id=eq.{user_id}
Request:
Get Onboarding Progress¶
Endpoint: Custom logic based on: - Email verification status - Subscription status - Channel count
Best Practices¶
- Email Verification
- Verify email promptly
- Check spam folder
- Use accessible email
-
Resend if needed
-
Subscription Selection
- Choose appropriate plan
- Start with trial if available
- Understand plan features
-
Can upgrade later
-
Channel Setup
- Connect at least one channel
- Use channels you'll actually use
- Can add more later
-
Test channel connection
-
Onboarding Completion
- Complete all steps
- Don't skip unless necessary
- Review setup before finishing
- Access platform after completion
Troubleshooting¶
Email Verification Not Received¶
Issue: Verification email not arriving
Solutions: - Check spam folder - Verify email address correct - Resend verification email - Check email server status
Cannot Proceed Past Verification¶
Issue: Stuck on verification step
Solutions: - Verify email clicked - Check verification status - Refresh page - Contact support
Subscription Step Not Showing¶
Issue: Not redirected to pricing
Solutions: - Verify email confirmed - Check subscription status - Refresh page - Try direct navigation to /pricing
Channel Setup Not Appearing¶
Issue: Channel step not showing
Solutions: - Verify subscription active - Check onboarding status - Refresh page - Verify step sequence
Related Documentation¶
Last Updated: January 2025