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

Was this helpful?

  1. SDK Features

Identify your devices

Effortlessly identify, search, and filter devices on your dashboard by specifying custom key/value pairs as metadata. Learn more.

To help you identify, search, and filter devices in your Cobrowse dashboard, it's helpful to specify any meaningful metadata.

You may add any custom key/value pairs you'd like, and they will all be searchable and filterable in your online dashboard. We've added a few placeholders for convenience only - all fields are optional.

CobrowseIO.customData = {
    user_id: "<your_user_id>",
    user_name: "<your_user_name>",
    user_email: "<your_user_email>",
    device_id: "<your_device_id>",
    device_name: "<your_device_name>"
};

Swift

CobrowseIO.instance().customData = [
    CBIOUserIdKey: "<your_user_id>",
    CBIOUserNameKey: "<your_user_name>",
    CBIOUserEmailKey: "<your_user_email>",
    CBIODeviceIdKey: "<your_device_id>",
    CBIODeviceNameKey: "<your_device_name>"
]

Objective-C

CobrowseIO.instance.customData = @{
    CBIOUserIdKey: @"<your_user_id>",
    CBIOUserNameKey: @"<your_user_name>",
    CBIOUserEmailKey: @"<your_user_email>",
    CBIODeviceIdKey: @"<your_device_id>",
    CBIODeviceNameKey: @"<your_device_name>"
};
HashMap<String, String> customData = new HashMap<>();
customData.put("user_id", "<your_user_id>");
customData.put("user_name", "<your_user_name>");
customData.put("user_email", "<your_user_email>");
customData.put("device_id", "<your_device_id>");
customData.put("device_name", "<your_device_name>");
CobrowseIO.instance().customData(customData);
CobrowseIO.customData = {
    user_id: "<your_user_id>",
    user_name: "<your_user_name>",
    user_email: "<your_user_email>",
    device_id: "<your_device_id>",
    device_name: "<your_device_name>"
};
CobrowseIO.instance.setCustomData(<String, dynamic>{
    'user_id': '<your_user_id>',
    'user_name': '<your_user_name>',
    'user_email': '<your_user_email>',
    'device_id': '<your_device_id>',
    'device_name': '<your_device_name>'
});
CobrowseIO.Instance.CustomData = new Dictionary<string, object>
{
    { CobrowseIO.UserIdKey, "<your_user_id>" },
    { CobrowseIO.UserNameKey, "<your_user_name>" },
    { CobrowseIO.UserEmailKey, "<your_user_email>" },
    { CobrowseIO.DeviceIdKey, "<your_device_id>" },
    { CobrowseIO.DeviceNameKey, "<your_device_name>" }
};
CobrowseIO.Instance.CustomData = new Dictionary<string, object>()
{
    { CobrowseIO.UserIdKey, "<your_user_id>" },
    { CobrowseIO.UserNameKey, "<your_user_name>" },
    { CobrowseIO.UserEmailKey, "<your_user_email>" },
    { CobrowseIO.DeviceIdKey, "<your_device_id>" },
    { CobrowseIO.DeviceNameKey, "<your_device_name>" }
};
PreviousAccount configNextUse 6-digit codes

Last updated 3 months ago

Was this helpful?