Skip to content

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.

The settings navigation is organized into six categories. Admin-level tabs are only shown to Owners/Admins; personal-preference tabs are visible to everyone.

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.

2. Workspace

Organization administration.

  • Organization — organization name, slug, timezone (used for scheduling), and default currency (used for deals).
  • 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

Update Organization Settings

Endpoint: PATCH /rest/v1/organizations?id=eq.{org_id}

Request: 

{
 "name": "My Company",
 "slug": "my-company",
 "timezone": "America/New_York",
 "currency": "USD"
}

Generate API Key

Endpoint: POST /functions/v1/generate-api-key

Request: 

{
 "name": "Production API Key",
 "expires_at": "2025-12-31T23:59:59Z"
}

Response: 

{
 "api_key": "ak_xxxxxxxxxxxxx",
 "id": "key-uuid",
 "created_at": "2025-01-01T00:00:00Z"
}

Create Webhook

Webhook endpoints are stored in the webhook_configurations table (there is no webhooks table).

Endpoint: POST /rest/v1/webhook_configurations

Request: 

{
 "url": "https://example.com/webhook",
 "events": ["message.created", "conversation.created"],
 "secret": "webhook-secret-key"
}

Best Practices

  1. Organization Settings
  2. Set accurate timezone for proper scheduling
  3. Use appropriate currency for your region

  4. Keep organization name professional

  5. API Keys

  6. Generate separate keys for different environments
  7. Set expiration dates for security
  8. Rotate keys regularly

  9. Never commit keys to version control

  10. Webhooks

  11. Use HTTPS endpoints only
  12. Implement webhook signature verification
  13. Handle retries gracefully

  14. Monitor webhook delivery

  15. Notifications

  16. Request permissions at appropriate times
  17. Respect user preferences
  18. 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

Last Updated: January 2025