Documentation
Chat
- Getting Started
- Installation
- Core Concepts
- Escalation System
- Widget Keys
- Secret Keys (sk_)
- REST API
- Channels & Integrations
- Messaging Platform API
Voice
- Voice Agent
- Setup Guide
- Phone Numbers
- Outbound Campaigns
Platform
- Billing & Pricing
- Glossary
- FAQ
Core Concepts
Understand the fundamental concepts behind Sampan.club.
Organisations
An organisation is the top-level account that owns all resources. When you sign up, an organisation is created for you. Organisations have:
- A subscription plan that determines quotas and features
- One or more workspaces to organise your projects
- Members with different roles (owner, admin, member, viewer)
- Billing and usage tracking at the organisation level
Workspaces
Workspaces let you separate projects, clients, or departments within your organisation. Each workspace has its own:
- Knowledge bases and widget keys
- Conversations and analytics
- Support agents and escalation queues
- Team members with workspace-level roles
Starter plans include one workspace. Pro and above support multiple workspaces, which is useful for agencies managing several clients.
Teams
Teams are groups of members within a workspace. They help organise support agents and control who sees which escalations. Team leads can manage their team's queue independently.
Knowledge Bases
A knowledge base is the source of information your chatbot uses to answer questions. You can build knowledge bases from:
- Website crawling — point at a URL and we index the content
- Document uploads — PDF and Markdown files
- Custom text content and FAQs
Widget Keys
Widget keys are secure tokens that let you embed your chatbot on a website. Each key can be configured with:
- Allowed domains — restrict where the widget can load
- Message limits — daily and monthly caps
- Custom styling — brand colours, logo, welcome message
- Analytics tracking
Conversations
Every interaction between a visitor and your chatbot is tracked as a conversation. You can view conversation history, see analytics, and pick up where a visitor left off.
Escalation
When the chatbot can't resolve an issue, conversations can be escalated to human support agents. The visitor provides their name and email, then an available agent in the workspace picks up the chat with full context.
Roles & Permissions
Access is controlled through role-based permissions at each level:
- Organisation — owner, admin, member, viewer
- Workspace — owner, admin, member, viewer
- Team — lead, member
Organisation owners and admins automatically have full access to all workspaces. Workspace members only see the workspaces they belong to.
