# Unblu

> Unblu is an enterprise conversational engagement platform for financial services and regulated industries. It enables agents and relationship managers to engage with clients and website visitors through live chat, secure messaging, audio/video calls, co-browsing, screen sharing, and document collaboration. Unblu can be deployed in the cloud or on-premises.

This documentation covers Unblu 8 (Spark). Documentation for older versions is available for [Unblu 7](https://docs.unblu.com/7/) and [Unblu 6](https://docs.unblu.com/6/).

Key concepts:

- **Collaboration Server**: The central backend managing conversations, users, and integrations.
- **Conversations**: The core communication unit between visitors and agents, supporting text, files, audio/video, and collaboration layers.
- **Collaboration layers**: Visual tools layered on top of conversations (co-browsing, screen sharing, whiteboard, document sharing).
- **Agent Desk**: The web-based agent workspace for managing conversations and collaboration.
- **Named areas**: Logical groupings of visitor-facing pages used for routing and configuration.
- **Configuration cascade**: Settings applied at global, account, named area, and API key scopes, with lower scopes overriding higher ones.

## Getting started

- [Welcome to Unblu](https://docs.unblu.com/latest/knowledge-base/introduction/welcome.html): Overview of Unblu features and capabilities
- [Fundamental concepts](https://docs.unblu.com/latest/knowledge-base/introduction/fundamental-concepts.html): Core concepts including accounts, conversations, visitors, and agents
- [Architecture overview](https://docs.unblu.com/latest/knowledge-base/introduction/architecture/overview.html): Server components, deployment diagrams, and system topology
- [Deployment models](https://docs.unblu.com/latest/knowledge-base/introduction/deployment-models.html): Cloud vs. on-premises deployment options
- [Quickstart](https://docs.unblu.com/latest/knowledge-base/installation-migration/quickstart.html): Step-by-step setup guide for different deployment models

## Cloud

- [Cloud onboarding](https://docs.unblu.com/latest/knowledge-base/cloud/cloud-onboarding.html): Getting started with Unblu Cloud
- [Cloud SSO](https://docs.unblu.com/latest/knowledge-base/cloud/cloud-sso.html): Cloud single sign-on configuration
- [Cloud admin application](https://docs.unblu.com/latest/knowledge-base/cloud/cloud-admin-application.html): Cloud-specific admin features

## Installation and migration

- [Cluster deployment](https://docs.unblu.com/latest/knowledge-base/installation-migration/cluster-deployment/cluster-deployment.html): Kubernetes and OpenShift deployment
- [Database setup (PostgreSQL)](https://docs.unblu.com/latest/knowledge-base/installation-migration/db-installation/postgresql-setup.html): PostgreSQL installation
- [Database setup (MySQL)](https://docs.unblu.com/latest/knowledge-base/installation-migration/db-installation/mysql-setup.html): MySQL installation
- [Blob store](https://docs.unblu.com/latest/knowledge-base/installation-migration/db-installation/blob-store.html): Document storage configuration
- [SecureFlow Manager](https://docs.unblu.com/latest/knowledge-base/installation-migration/sfm/sfm.html): SFM for embedded co-browsing resource protection
- [Hardening](https://docs.unblu.com/latest/knowledge-base/installation-migration/hardening/hardening-installation.html): Security hardening guide
- [Migration to Unblu Spark 8](https://docs.unblu.com/latest/knowledge-base/installation-migration/migration/migrating-to-unblu-spark-8.html): Version migration guide
- [Licensing](https://docs.unblu.com/latest/knowledge-base/installation-migration/other/licensing.html): License management

## Configuration

- [Configuring the Collaboration Server](https://docs.unblu.com/latest/knowledge-base/configuration/basics/configuration.html): Configuration properties, files, and dynamic vs. immutable settings
- [Scope configuration cascade](https://docs.unblu.com/latest/knowledge-base/guides/conceptual/scope-configuration-cascade.html): How settings cascade across global, account, named area, and API key scopes
- [API keys](https://docs.unblu.com/latest/knowledge-base/configuration/basics/api-keys.html): API key management and scoped configuration
- [Named areas](https://docs.unblu.com/latest/knowledge-base/configuration/basics/named-areas.html): Defining visitor areas for routing and configuration
- [Routing strategy](https://docs.unblu.com/latest/knowledge-base/configuration/basics/routing-strategy-configuration.html): Conversation routing and dispatch rules
- [Queue configuration](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/queue-configuration.html): Queue management for agent workloads
- [Authentication](https://docs.unblu.com/latest/knowledge-base/configuration/users-teams/authentication.html): SSO, LDAP, and SAML setup
- [Service principals](https://docs.unblu.com/latest/knowledge-base/configuration/users-teams/service-principals.html): Service account authentication for integrations
- [Localization](https://docs.unblu.com/latest/knowledge-base/configuration/basics/localization.html): Multi-language support
- [Record retention policies](https://docs.unblu.com/latest/knowledge-base/configuration/basics/record-retention-policies.html): Data retention configuration
- [Importing and exporting configuration](https://docs.unblu.com/latest/knowledge-base/configuration/basics/importing-and-exporting-configuration-overview.html): Export and import settings across environments for migration and staging workflows

## Analytics

- [Introduction to Unblu analytics](https://docs.unblu.com/latest/knowledge-base/analytics/intro.html): Overview of Unblu's account-based analytics offering
- [Setting up account-based analytics](https://docs.unblu.com/latest/knowledge-base/analytics/setup.html): Three-step setup flow for BigQuery or PostgreSQL backend

## UI and theming

- [UI customization guide](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-customization-guide.html): Customizing Agent Desk and visitor UI behavior and appearance
- [Enterprise UX Kit](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/enterprise-ux-kit.html): Enterprise design system for advanced theming
- [Branding](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/branding.html): Brand identity configuration
- [UI theming cheat sheets](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming.html): UI theming cheat sheets

## Conversations

- [Conversation visibility](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/configuring-conversation-visibility.html): Privacy and visibility settings
- [Invitations and forwardings](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/configuring-invitations-forwardings.html): Inviting and forwarding conversations between agents
- [File uploads](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/configuring-file-uploads.html): File sharing configuration
- [Outbound conversations](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/outbound-conversations.html): Proactive outreach to visitors
- [Configuring the concierge](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/concierge/configuring-the-concierge.html): Automated greeting bot setup
- [Conversation summaries](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/generate-conversation-summaries.html): AI-generated conversation summaries
- [Scheduled conversations](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/configuring-scheduled-conversations.html): Scheduling future conversations
- [Email notifications](https://docs.unblu.com/latest/knowledge-base/configuration/conversations/outgoing-emails.html): Outgoing email notification setup
- [Push notifications](https://docs.unblu.com/latest/knowledge-base/configuration/notifications/push-notifications.html): Push notification configuration

## Collaboration layers

- [Collaboration layers overview](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/intro-collaboration-layers.html): Visual collaboration tools that layer on top of conversations
- [Embedded co-browsing](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/embedded-co-browsing/configuring-embedded-co-browsing.html): Co-browsing the same website the visitor is on
- [Universal co-browsing](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-universal-co-browsing.html): Co-browsing any website via headless rendering
- [Screen sharing](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-screen-sharing.html): Desktop and application screen sharing
- [Document collaboration](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-document-collaboration.html): Shared document viewing and annotation
- [Native document collaboration](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-native-document-collaboration.html): In-browser document collaboration with Apryse WebViewer and PDF signing
- [Server-based document collaboration](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-server-based-document-collaboration.html): Document collaboration via the Rendering Service and WebRTC
- [Whiteboard](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/configuring-whiteboard.html): Collaborative whiteboard tool
- [Conversation recording](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/conversation-recording.html): Recording conversations and collaboration sessions
- [Rendering service](https://docs.unblu.com/latest/knowledge-base/configuration/collaboration-layers/rendering-service/render.html): Headless browser rendering for universal co-browsing

## Audio and video

- [Call configuration](https://docs.unblu.com/latest/knowledge-base/configuration/audio-video/call-configuration.html): Audio/video call feature setup
- [Video chat setup (LiveKit)](https://docs.unblu.com/latest/knowledge-base/configuration/audio-video/video-chat-setup-livekit.html): LiveKit-based video integration
- [Closed captions](https://docs.unblu.com/latest/knowledge-base/configuration/audio-video/closed-captions.html): Real-time captioning for accessibility

## Frontend integration

- [Floating Visitor UI integration](https://docs.unblu.com/latest/knowledge-base/integration/frontend/floating-visitor-ui.html): Embedding the floating chat widget on websites
- [SPA integration](https://docs.unblu.com/latest/knowledge-base/integration/frontend/spa-integration.html): Single-page application integration
- [Visitor authentication (JWT)](https://docs.unblu.com/latest/knowledge-base/integration/frontend/visitor-login-jwt.html): JWT-based visitor login
- [JavaScript API overview](https://docs.unblu.com/latest/knowledge-base/integration/frontend/js-api.html): JavaScript API for frontend integration
- [Browser requirements](https://docs.unblu.com/latest/knowledge-base/integration/frontend/browser-requirements.html): Supported browsers and versions for visitors and agents

## Network integration

- [Reverse proxy integration](https://docs.unblu.com/latest/knowledge-base/integration/network/reverse-proxy-integration.html): Reverse proxy and WAF setup
- [Airlock WAF integration](https://docs.unblu.com/latest/knowledge-base/integration/network/airlock-with-protected-resources.html): Airlock WAF with protected resources

## Web API and webhooks

- [Web API and webhooks](https://docs.unblu.com/latest/knowledge-base/integration/web-api-webhooks/web-api.html): REST API for CRM, call center, and identity integrations
- [Webhooks technical details](https://docs.unblu.com/latest/knowledge-base/integration/web-api-webhooks/webhooks-technical-detail.html): Webhook registration, events, and HTTP payloads
- [Outbound request mechanism](https://docs.unblu.com/latest/knowledge-base/integration/web-api-webhooks/outbound-request-mechanism.html): Server-to-server outbound request feature

## Bot and third-party integration

- [Bot integration](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/bots.html): Dialog bots and conversation-observing bots
- [Dialog bots](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/dialog-bots.html): Bots that interact directly with visitors
- [Unblu Conversational Bot](https://docs.unblu.com/latest/knowledge-base/integration/ucb/introduction.html): Built-in NLU bot with intent-based and LLM-powered knowledge bot
- [Knowledge bot](https://docs.unblu.com/latest/knowledge-base/integration/ucb/knowledge-bot.html): LLM-powered bot for answering questions from a knowledge base
- [Bot Dialog Builder](https://docs.unblu.com/latest/knowledge-base/integration/ucb/bot-dialog-builder.html): Visual dialog flow builder
- [Custom actions](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/custom-actions.html): Custom conversation and person actions
- [Chat suggestions](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/chat-suggestions.html): Agent response suggestions
- [Message interceptors](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/message-interceptors.html): Message preprocessing middleware
- [External messengers](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/external-messenger.html): Messenger channel integration
- [WhatsApp](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/whatsapp.html): WhatsApp Business channel
- [Microsoft Teams](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/microsoft-teams.html): Microsoft Teams integration
- [Salesforce](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/salesforce.html): Salesforce CRM integration

## Mobile SDKs

- [Mobile SDK introduction](https://docs.unblu.com/latest/knowledge-base/mobile/mobile-intro.html): Overview of Android and iOS SDK features
- [Mobile configuration](https://docs.unblu.com/latest/knowledge-base/mobile/mobile-configuration.html): Server-side mobile setup
- [Android SDK setup](https://docs.unblu.com/latest/knowledge-base/mobile/android/code-setup-initialization.html): Android SDK initialization and configuration
- [Working with the Android SDK](https://docs.unblu.com/latest/knowledge-base/mobile/android/working-with-android-sdk.html): Android API usage patterns
- [iOS SDK setup](https://docs.unblu.com/latest/knowledge-base/mobile/ios/code-setup-initialization.html): iOS SDK initialization and configuration
- [Working with the iOS SDK](https://docs.unblu.com/latest/knowledge-base/mobile/ios/working-with-ios-sdk.html): iOS API usage patterns

## Guides

- [Agent Desk guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/agent-desk-guide.html): Agent workspace walkthrough
- [Floating Visitor UI guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/floating-visitor-ui-guide.html): Visitor chat widget guide
- [Embedded Visitor UI guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/embedded-visitor-ui-guide.html): Embedded visitor interface guide
- [Queue dispatching](https://docs.unblu.com/latest/knowledge-base/guides/conceptual/queue-dispatching.html): How conversations are dispatched from queues to agents
- [Account Configuration guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/account-configuration-interface-guide.html): Admin interface for managing account-level settings, users, teams, and named areas
- [Global Configuration guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/global-configuration-interface-guide.html): Superadmin interface for managing global settings across all accounts
- [Branch Editor guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/branch-editor-guide.html): Interface for building and customizing Unblu Branch client applications
- [Branch Client Setup guide](https://docs.unblu.com/latest/knowledge-base/guides/ui/branch-client-setup-interface-guide.html): Interface for configuring Branch client deployments

## API reference

- [Web API reference](https://docs.unblu.com/latest/reference/unblu-web-api/): REST API reference with all endpoints, schemas, and webhooks
- [OpenAPI specification](https://docs.unblu.com/latest/downloads/unblu.yaml): OpenAPI 3.1.0 spec for the Unblu web API
- [Floating JS API reference](https://docs.unblu.com/latest/reference/unblu-floating-js-api/): JavaScript API for the floating visitor UI
- [Branch JS API reference](https://docs.unblu.com/latest/reference/unblu-branch-js-api/): JavaScript API for the Branch client
- [Android SDK reference](https://docs.unblu.com/latest/reference/mobile-sdk-android/): Android SDK Javadoc
- [iOS SDK reference](https://docs.unblu.com/latest/reference/mobile-sdk-ios/): iOS SDK reference

## Reference

- [Glossary](https://docs.unblu.com/latest/glossary.html): Definitions of Unblu terms and concepts
- [Conversation lifecycle](https://docs.unblu.com/latest/knowledge-base/reference/conversation-lifecycle.html): Conversation and participation state machine
- [Conversation elements](https://docs.unblu.com/latest/knowledge-base/reference/conversation-elements.html): Message and conversation structure
- [Conversation timeline](https://docs.unblu.com/latest/knowledge-base/guides/conceptual/conversation-timeline.html): Message flow and timeline concepts
- [Message types](https://docs.unblu.com/latest/knowledge-base/reference/message-types.html): Message categorization
- [User roles](https://docs.unblu.com/latest/knowledge-base/reference/user-roles.html): Permission roles and access levels
- [HTTP headers](https://docs.unblu.com/latest/knowledge-base/reference/http-headers.html): Required HTTP headers for integration
- [Content Security Policy](https://docs.unblu.com/latest/knowledge-base/reference/csp.html): CSP requirements for Unblu
- [Cookies](https://docs.unblu.com/latest/knowledge-base/reference/cookies.html): Cookie specifications
- [Accessibility](https://docs.unblu.com/latest/knowledge-base/reference/accessibility.html): WCAG compliance details

## Troubleshooting

- [Logging](https://docs.unblu.com/latest/knowledge-base/troubleshooting/logging.html): Log configuration and analysis
- [Audit log](https://docs.unblu.com/latest/knowledge-base/troubleshooting/audit-log.html): Audit trail features
- [Server diagnostics](https://docs.unblu.com/latest/knowledge-base/troubleshooting/server-diagnostics-package.html): Diagnostic package tool

## Optional

- [Configuration properties](https://docs.unblu.com/latest/reference/configuration-properties.html): Complete server configuration property reference (~230K words)
- [Text properties](https://docs.unblu.com/latest/reference/text-properties.html): UI text and localization property reference
- [SMS text messaging](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/sms-text-messaging.html): SMS text message notifications via Twilio
- [Embedded JS API reference](https://docs.unblu.com/latest/reference/unblu-embedded-js-api/): JavaScript API for the embedded visitor UI
- [Copilot agents](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/copilot-agents.html): Microsoft Copilot Studio agent integration
- [Outlook add-in](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/outlook-add-in.html): Outlook scheduling integration
- [Google Calendar add-on](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/google-calendar-add-on.html): Google Calendar scheduling integration
- [Microsoft Bookings](https://docs.unblu.com/latest/knowledge-base/integration/third-party-software/microsoft-booking.html): Microsoft Bookings integration
- [General theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-general.html): General theming, such as colors, fonts, and icon backgrounds
- [Conversation theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-conversation.html): Theming conversation elements across all UIs
- [Visitor UI theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-visitor.html): Theming the Visitor UIs, such as the Floating Visitor UI
- [Agent UI theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-agent.html): Theming the Agent UIs, such as the Agent Desk
- [Unblu Branch UI theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-branch.html): Theming the UI for Unblu Branch clients
- [Configuration UI theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-configuration.html): Theming the configuration UIs, such as the Account Configuration interface
- [Headless browser theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-headless-browser.html): Theming the headless browser used by the Rendering Service for various collaboration layers
- [Native document collaboration theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-native-document-collaboration.html): Theming the native document collaboration interface
- [Mobile theming](https://docs.unblu.com/latest/knowledge-base/configuration/ui-theming/ui-theming-mobile.html): Theming the mobile SDKs


- [Release notes](https://docs.unblu.com/latest/release-notes/): Unblu release notes
- [Android SDK release notes](https://docs.unblu.com/latest/release-notes/mobile-sdk-android.html): Android SDK release notes
- [iOS SDK release notes](https://docs.unblu.com/latest/release-notes/mobile-sdk-ios.html): iOS SDK release notes
- [Security bulletins](https://docs.unblu.com/latest/security-bulletins/): Security advisories and vulnerability disclosures