Cobrowse.io Docs

Cobrowse.io Docs

• Getting started: Steps to see Cobrowse running in your own apps and websites, including third party content.
• Web: Javascript SDK for Web
• iOS: iOS Native SDK
• Android: Android Native SDK, with support for Compose and native webviews
• React Native: React Native SDK
• Flutter: Flutter iOS and Android SDK
• .NET Mobile: .NET iOS and Android SDK
• macOS: MacOS SDK for native desktop applications
• Windows: Windows SDK for native desktop applications
• Account config: Cobrowse account config. Account-level settings may be configured once you have logged in.
• Identify your devices: Effortlessly identify, search, and filter devices on your dashboard by specifying custom key/value pairs as metadata. Learn more.
• Use 6-digit codes: Cobrowse does not require any visible UI presented to the user but there is the option to present a UI that generates a 6-digit code. Learn more.
• Redact sensitive data: Block sensitive data from being visible to support agents during a Cobrowse session.
• Web
• iOS
• Android
• React Native
• Flutter
• .Net MAUI
• Redaction Playground
• Viewing PDFs: Ensure a seamless experience when viewing PDF documents.
• Universal Cobrowse: For the times where it's not possible to include the Cobrowse Web SDK into the site.
• Customize the interface: Cobrowse customers can use the default UI straight out of the box, or opt to customize the interface to meet their specific requirements.
• Active session controls: Cobrowse active session controls. You can fully customize the interface for a Cobrowse session, including how to end a session.
• 6-digit code screen: Cobrowse SDK features. If you want to customize the interface, here's how to to use a custom UI for the 6-digit code screen.
• User consent dialog: By default, Cobrowse will show a user consent dialog when a new session is incoming. You may modify and customize the consent prompt using the SDK.
• Remote control consent dialog: Learn how to customize the remote control consent prompt to your needs.
• Full device consent dialog: Learn how to customize the full device consent prompt which is required by some of our supported platforms.
• Localization / translation: Customise and localize the Cobrowse interface to offer a tailored experience. The website SDK provides support for more than 20 languages.
• Initiate sessions with push: For use with Android, iOS, React Native, Flutter, and .NET Mobile SDKs only.
• Listening for events: Learn how to listen to the various events that the Cobrowse SDKs exposes to hook in to the lifecycle of a Cobrowse session.
• Full device capabilities: Enable your support agents to escalate in-app Cobrowse sessions to full device screen sharing or remote control, facilitating comprehensive assistance.
• Full device screen sharing: Full device screen sharing enables agents to view screens from applications outside of your own, view settings and inter-application browsing.
• Full device remote control: Enable full device remote control on Android and Windows SDKs, allowing support agents to modify system settings or control apps on a user's device.
• Managing full device mode: Learn how to promote a session to full device mode using the SDK, as per your requirements.
• Advanced configuration: Advanced SDK configurations. Learn more about starting and stopping the SDK, declaring capabilities and web, iOS and Android config.
• Starting and stopping the SDK: Have greater control over when the SDK is running.
• Declaring capabilities: Cobrowse allows for different levels of capabilities which can be enabled or disabled from the settings of the dashboard or SDKs.
• Session metrics: Monitor session metrics in realtime to understand session quality.
• Intercepting mobile SDK network requests: Have greater control over networking requests made by the mobile SDKs.
• Web: Advanced web features for Cobrowse, including iFrame supprt, ignore views and cross-domain session support.
• IFrames support: To use Cobrowse for Web with cross document IFrames you will need to add a javascript snippet to the page being embedded.
• Cross-domain session support: Javascript for sessions across multiple domains or sub-domains.
• Ignore Views: Ignore views in Cobrowse. It may be useful to ignore specific views from being presented to the agents. Use this javascript snippet.
• iOS: Advances features of Cobrowse for iOS, including alternate render method and custom touch handling.
• Alternate render method: Some iOS apps with custom controls, lots of animation, or complex visual effects, can benefit from alternate render methods used by the Cobrowse iOS SDK.
• Custom touch handling: Most iOS apps are supported out of the box by our remote control feature. For others, we provide support for custom touch handling.
• Android: Cobrowse for Android. Here are some articles to help with challenges related to Android such as Backporting TLS 1.2 to Android 4.4
• Backporting TLS to older Android versions: Ensuring compatibility with legacy Android OS devices on Cobrowse by backporting TLS 1.2 and TLS 1.3.
• Cobrowse virtual agents: AI-powered virtual agents for automated customer support
• Cobrowse MCP: Enable your AI agents to cobrowse with users by integrating the Cobrowse MCP server.
• Agent-side overview: 100% white label, not just colors and logos. Add-on Cobrowse to your CRM, contact center, agent desktop, or any CX solutions you already use.
• Platform integrations: Out-of-box integrations for leading CCaaS providers including Intercom, Zendesk, Genesys, Salesforce, Freshworks, Talkdesk, NICE, Five9 and Microsoft Dynamics 365, as well as many private CX platforms
• Zendesk: Cobrowse provides an integration with both Zendesk Support and Zendesk Chat, available from the Zendesk App Marketplace.
• Salesforce: Easily start a Cobrowse session from Salesforce.
• Migrating from legacy to v2: Uninstalling v1 (legacy) and getting set up with v2 of our Salesforce integration
• Salesforce (Legacy): v1.x
• Genesys: Cobrowse.io for Genesys supports Genesys Cloud CX, Genesys Engage Cloud, Genesys Engage Workspace Web Edition (WWE) and more.
• Genesys Cloud: The Cobrowse integration for Genesys Cloud may be installed from the App Foundry.
• Engage Workspace Web Edition (WWE): Engage Cloud and Engage On-Premise WWE
• Engage Workspace Desktop Edition (WDE): Plugin version v1.x
• Intercom: Cobrowse integrates with Intercom and is available from the Intercom App Store. Find out more.
• Freshworks: Cobrowse provides an integration with Freshdesk and Freshchat, available from the Freshdesk and Freshchat App Marketplaces.
• Talkdesk: Equip your agents with powerful cobrowsing capabilities right from the Talkdesk workspace™.
• NICE CX: Cobrowse integrates with CXOne providing seamless Digital and Phone connectivity.
• Dynamics 365: Cobrowse integrates seamlessly with Microsoft Dynamics 365 Customer Service, enabling real-time visual collaboration between agents and customers.
• Five9: Easily start a Cobrowse session from Five9
• ServiceNow: Cobrowse integrates seamlessly with ServiceNow workflows, enabling real-time visual collaboration between agents and customers.
• Amazon Connect: Easily start a Cobrowse session from Amazon Connect
• Custom integrations: Customers may use custom integrations to deliver the agent-side UI directly into their own applications.
• Agent SDK: Client-side JavaScript SDK to build custom agent-side integrations
• API Reference: Agent SDK API reference
• Sample code snippets: Build the experience that you want for your support agents with our powerful agent SDK. Here are some examples of commonly required functionality.
• Authentication (JWTs): Learn how to generate JSON Web Tokens (JWTs) for automatic authentication when using the Agent JS API and/or IFrame embeds.
• JWT Policies: Our JWT policy system provides a powerful mechanism to limit what a given agent can do. Which devices a support agent can connect to or which sessions they are allowed to view are a few examples.
• Authentication (SAML 2.0): Allow your users to authenticate using your SAML 2.0 identity provider for simple SSO.
• IFrame embeds: Cobrowse provides a range of embeddable URLs to suit a range of use cases, including full dashboard embeds, direct device connection or screen-share only.
• Self-hosting overview: Deploy your own instance of Cobrowse in your own AWS, Azure, or Google Cloud account, or fully on-premises including support for air-gapped networks.
• Docker Compose: Learn how to use Docker Compose to set up Cobrowse Enterprise on a single host.
• Helm chart: Learn how to use Helm to set up Cobrowse Enterprise in your Kubernetes cluster.
• Image Pull Secret: Using private repositories on your deployment.
• Environment Variables: How your Cobrowse deployment can be configured.
• Optional recording components: Minimising resource usage by disabling the recording components.
• Pod Annotations: Further configure your deployment by using pod annotations.
• AWS terraform: This is the documentation for how to use our Terraform for AWS to set up Cobrowse Enterprise in your cloud.
• AWS metrics configuration: AWS metrics configuration. Our Terraform can set everything up to export your Cobrowse EKS cluster metrics into CloudWatch for charting and alerts.
• Azure terraform: Learn how to use Terraform for Azure to set up Cobrowse Enterprise in your cloud.
• Azure metrics configuration: Configure Cobrowse on Microsoft Azure using the provided Terraform configurations, and seamlessly integrate with Azure Monitor for insightful container metrics.
• GCP terraform: Learn how to use our Terraform for GCP to set up Cobrowse Enterprise in your cloud.
• GCP metrics configuration: Utilize Cobrowse's Google Cloud Terraform configuration for an effortless setup on GCP, ensuring efficient metric collection via Google Cloud's Workload Metrics
• Sizing guidelines: In determining hardware requirements for self-hosted or on-premise deployments, please use the following numbers as a guide.
• Running your instance: Getting started with Cobrowse. Follow these simple steps to bootstrap your account and configure the SDK to use your private instance.
• Adding a superuser: How to set up superusers on your self-hosted Cobrowse instance to manage global administrative tasks.
• Limiting account creation: Control account creation on your self-hosted Cobrowse instance by configuring specific email addresses or domains that are allowed to create new accounts.
• Limiting magic link recipients: How can you control who receives a magic link email?
• Configuring SMTP: How to configure a custom SMTP server on your self-hosted Cobrowse.io instance for sending magic link login emails via your company email.
• Managing your deployment: Manage your Cobrowse deployment effectively by regularly backing up the database, staying updated on new releases, and more.
• Monitoring your instance: Monitor your self-hosted Cobrowse.io instance effectively by leveraging the OpenMetrics/Prometheus exposition format.
• Available metrics: Custom Cobrowse metrics are available via OpenMetrics endpoints and include counters, gauges and summaries.
• Self-Hosted Prometheus: Implement self-hosted Prometheus and Grafana in your Cobrowse Enterprise Kubernetes cluster for enhanced monitoring and data visualization.
• Advanced configuration: Browse more advanced Cobrowse configurations, including Air Gap, Docker Proxy and L7 Firewall configuration.
• Air gap configuration: Learn how to install Cobrowse Enterprise with an air gap configuration, isolated from public internet and untrusted local networks.
• Pin web SDK version: Web SDK pinning. For customers that prefer to pin the version of the SDK to one shipped and tested with their Cobrowse Enterprise deployment.
• L7 firewall configuration: L7 Firewall configuration. This guide provides helpful information if you need to secure your Cobrowse implementation behind a L7 firewall.
• Docker proxy configuration: Learn how to configure docker proxy when using Cobrowse enterprise.
• Troubleshooting: Troubleshooting your self-hosted deployment.

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.cobrowse.io/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.