Settings Feature¶
Overview¶
The Settings page (/settings) provides comprehensive configuration options for your organization, team members, channels, integrations, and system preferences. It's the central hub for managing all aspects of your ConnectGain workspace.
Settings, grouped by area.
The settings navigation is organized into six categories. Admin-level tabs are only shown to Owners/Admins; personal-preference tabs are visible to everyone.
On this page:
Features¶
Settings are grouped into these six categories:
1. My Preferences¶
Personal settings that apply only to your own account.
- Notifications — enable/disable browser push notifications, manage permissions, view notification status, and automatic subscription on login (Web Push API; Android via Chrome/Firefox/Samsung Internet; iOS via Safari PWA on iOS 16.4+).
- Chat & Contacts — personal chat and contact display preferences.
- Inbox Layout — customize how the inbox is laid out for you.
- Mobile App — download links for the ConnectGain mobile app (Google Play and the Apple App Store), so you can read and reply to conversations from your phone. The same link is always one click away from the header's Get the app icon, on any screen size — you don't need to be on a phone to find it.
2. Workspace¶
Organization administration.
- Organization — organization name, slug, timezone (used for scheduling), and default currency (used for deals). It also holds three switches for how agents use the dashboard (owners and admins are never affected by them):
- Let agents set themselves Online / Offline (on by default) — shows the Online / Offline switch in the header so an agent can pause their own auto-assignment. Turn it off to remove the switch for everyone.
- Lock the dashboard layout for agents (off by default) — agents see the standard dashboard and cannot reorder, hide, add, edit or delete widgets. See Dashboard.
- Agents see only their own dashboard and analytics (off by default) — dashboard widgets and the Analytics page count only the conversations assigned to the agent and the deals, tasks and contacts they own. Unassigned conversations are not counted. See Analytics.
- Team Members — view members, invite new members, manage roles/permissions/availability, and remove members. See Team Management.
- Teams — create and manage sub-teams and their members (Team Admins).
- Sidebar Menu — customize which items appear in the sidebar navigation.
3. Inbox & Messaging¶
- Channels — connect and manage messaging channels. See Channels.
- Email Boxes (Beta) — connect IMAP/SMTP email inboxes.
- Message Templates — reusable message templates.
- Quick Replies — short canned responses for agents.
- WhatsApp Templates — manage approved WhatsApp Cloud templates.
- Tags & Labels — define tags and labels for conversations and contacts.
- Lifecycle Stages — configure contact lifecycle stages.
- SLA & Escalation — configure response-time SLAs and escalation rules.
- External Pages — manage external/embedded pages.
4. AI & Automation¶
- AI Provider — choose ConnectGain AI or bring your own Gemini key (BYOK). See BYOK Gemini.
- AI Re-Engagement — configure automated re-engagement nudges.
- AI Summaries — configure conversation/AI summarization.
- Enrichment Tools — configure contact enrichment.
- Call Intelligence — configure call recording analysis and vendors.
5. Storage & Developer¶
- Media Storage — configure media storage.
- Storage Usage & Cleanup — monitor storage usage and clean up files (internal Appgain accounts).
- API Keys — generate, view, and revoke API keys; set expiration; track usage.
- Webhooks — create webhook endpoints, configure subscribed events, test delivery, and view delivery logs.
6. Danger Zone¶
A dedicated top-level category (not part of the Organization tab).
- Delete all data — confirmation required (type "DELETE ALL DATA"). Deletes companies, conversations, contacts, deals, tasks, templates, automations, and bot flows.
Member Roles¶
Team Members support five roles (see Team Management for details):
- Owner — full access to all features and organization settings.
- Admin — manage users, settings, and team members.
- Agent — access to conversations, contacts, deals, and tasks.
- Project Manager — projects/PM access; excluded from agent auto-assignment and agent-performance reports.
- Team Admin — manages a sub-team via the Teams tab.
Use Cases¶
Use Case 1: Configure Organization Settings¶
Scenario: Admin wants to update organization timezone and currency.
Steps: 1. Go to Settings → Organization 2. Update organization name if needed 3. Select timezone from dropdown 4. Select currency from dropdown 5. Click "Save Changes" 6. Verify settings updated
Expected Outcome: Organization settings updated successfully.
Use Case 2: Generate API Key¶
Scenario: Developer needs API key for integration.
Steps: 1. Go to Settings → API Keys 2. Click "Generate New API Key" 3. Enter key name/description 4. Set expiration date (optional) 5. Click "Generate" 6. Copy API key immediately 7. Store securely
Expected Outcome: API key generated and ready for use.
Use Case 3: Configure Webhook¶
Scenario: Admin wants to receive webhook events for new messages.
Steps: 1. Go to Settings → Webhooks 2. Click "Add Webhook" 3. Enter webhook URL 4. Select events to subscribe to: - message.created - conversation.created 5. Enter secret key 6. Click "Save" 7. Test webhook delivery 8. Verify webhook active
Expected Outcome: Webhook configured and receiving events.
Use Case 4: Enable Browser Notifications¶
Scenario: User wants to receive browser notifications for new messages.
Steps: 1. Go to Settings → Notifications 2. Click "Enable Notifications" 3. Grant browser permission when prompted 4. Verify notification enabled 5. Test notification delivery
Expected Outcome: Browser notifications enabled and working.
API Integration¶
Organization settings are managed in the app and are not exposed through the API.
Generate API Key¶
Endpoint: POST /functions/v1/generate-api-key (signed-in owner or admin)
Request:
Response:
The key is shown once. Use it in the X-API-Key header — see
API key authentication.
Webhooks¶
Webhook endpoints are created in Settings → Webhooks — see the Webhooks overview.
Best Practices¶
- Organization Settings
- Set accurate timezone for proper scheduling
- Use appropriate currency for your region
-
Keep organization name professional
-
API Keys
- Generate separate keys for different environments
- Set expiration dates for security
- Rotate keys regularly
-
Never commit keys to version control
-
Webhooks
- Use HTTPS endpoints only
- Implement webhook signature verification
- Handle retries gracefully
-
Monitor webhook delivery
-
Notifications
- Request permissions at appropriate times
- Respect user preferences
- Provide clear notification content
Troubleshooting¶
API Key Not Working¶
Issue: API key authentication failing
Solutions: - Verify key copied correctly - Check key not expired - Verify key not revoked - Check API endpoint URL correct
Webhook Not Receiving Events¶
Issue: Webhook endpoint not receiving events
Solutions: - Verify webhook URL accessible - Check webhook active status - Verify event subscriptions correct - Check webhook logs for errors - Test webhook endpoint manually
Notifications Not Working¶
Issue: Browser notifications not appearing
Solutions: - Check browser notification permissions - Verify notifications enabled in settings - Check browser notification settings - Test with different browser
Related Documentation¶
Last Updated: January 2025
More screens¶
Connected channels and their status.
Where you add your own AI provider key.
ConnectGain — omnichannel inbox, CRM & automation for WhatsApp, Messenger, Instagram, Telegram and more. Open the app · Docs home