Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page
  • Quick start demo
  • Authentication
  • Features

Was this helpful?

  1. Agent-side integrations

Agent SDK

Client-side JavaScript SDK to build custom agent-side integrations

PreviousCustom integrationsNextAPI Reference

Last updated 1 year ago

Was this helpful?

Our Agent SDK can be used to build 100% customized agent-side integrations into your own products and services. You can use to both to access our API and to control embedded Cobrowse IFrames.

Quick start demo

Navigate to our and open up our in another browser tab to generate your Demo ID.

This Demo Page uses our , our , and ties it together into an .

Authentication

If you are using the Agent SDK just to communicate to an embedded IFrame, a JWT is not required.

Device and Session listing via the Agent SDK requires a JSON Web Token (JWT) for authentication. Learn how to generate a JWT for your account at .

Features

The Agent SDK can be used to:

  • List Devices and/or Sessions matching your filter criteria

    • Build your own 100% customized dashboard or device list

    • Show only a single user's devices in the context of a support ticket or chat

  • Subscribe to events on Devices and Sessions, for example to create a smart connect button that indicates when the devices goes online/offline

  • Interact with embedded Cobrowse iFrames

    • Get notified in the parent page when a session begins and ends

    • Attach a button in the parent page to end the session, or select the agent's tool

    • Programmatically end the session before the parent page closes

We have put together a list of commonly ask questions and useful code snippets to get you started:

You can find the full developer documentation for the agent SDK API here:

Agent SDK Demo Page
Cobrowse.io Online Demo
Agent UI component library
Agent SDK
Agent SDK Examples project
Authentication (JWTs)
Sample code snippets
API Reference