Integration patterns
Common ways teams integrate DocsChat. Pick components that match your stack and plan.
E-commerce support bot
Best for: Online stores with product pages and order questions.
| Component | Use |
|---|---|
| Widget embed | Chat bubble or iframe on product and checkout pages |
| REST API | Server-side order lookup before starting a session (custom backend) |
| Webhooks | Push order-status updates into an active chat session |
Typical flow: Embed widget on /product/* → user asks about shipping → bot answers from docs → handoff to helpdesk on Standard+ for returns.
SaaS customer success
Best for: In-app help and onboarding.
| Component | Use |
|---|---|
| Widget embed | Contextual help widget inside your app (iframe) |
| REST API | Pass user context from your backend when creating sessions |
| Analytics | Track deflection in Admin → Analytics (not a public API yet) |
Typical flow: Link iframe to /chat/docs-help from your dashboard → suggested questions guide new users → citations link to your public docs.
Enterprise knowledge base
Best for: Internal workspace support and compliance-sensitive teams.
| Component | Use |
|---|---|
| REST API | Custom internal dashboard or intranet integration |
| Webhooks | Sync messages with internal ticketing |
| SSO | Stub — configure in Admin → Enterprise; IdP wiring required for production |
| Audit logs | Enterprise — export from Admin → Audit log |
| HIPAA mode | Enterprise stub — enable flag + review docs/SECURITY.md before production |
Typical flow: Internal portal calls /api/v1/sessions with API key → employees chat against private doc sources → handoff creates Zendesk ticket with transcript.
Choosing a path
| Need | Start here |
|---|---|
| Fastest web embed | Widget embed |
| Mobile or custom UI | REST API integration |
| External system pushes messages | Webhooks |
Related
- Developer overview
- Admin setup:
docs/admin/onboarding.md