cobrowse-sdk-js-examples

Web example demo

Setup

1. Ensure you have the https://github.com/cobrowseio/cobrowse-sdk-js-examples repo cloned locally.
2. cd web-example
3. Replace trial seen at line 44 of ./src/hooks/useCobrowse.js` with your own license key. (Register a new account at https://cobrowse.io/register).
4. Run npm start from within the web-example directory

Query Parameters

The web demo supports these top-level query parameters:

• api
• license
• registration
• sdk_path
• custom_data using key:value,key2:value2 format
• redacted_views as a comma-separated list of selectors
• unredacted_views as a comma-separated list of selectors
• ignored_views as a comma-separated list of selectors
• capabilities as a comma-separated list
• custom_session_controls as true or false
• allow_headless as true or false
• session_code
• demo as true to bypass the login flow
• integration

For security reasons do not allow for the license key, sdk_path or api to be set via a query parameter in your own application.

Different integrations are also supported out of the box with the integration parameter: salesforce, salesforce-v2, zendesk, freshdesk, freshchat, intercom, genesys, genesys-messaging, talkdesk, nice, five9, amazonconnect, servicenow, ccaip or dynamics.

Example URLs:

• Salesforce: https://cobrowse-sdk-js-examples.cbrws.io/web-example/demo/?api=https://cobrowse.io&license=Xskn6AwiVgzBcQ&demo=true&custom_data=demo_id:219723078,device_name:Trial%20Website,user_email:web@example.com&integration=salesforce

• Dynamics 365 - Customer service https://cobrowse-sdk-js-examples.cbrws.io/web-example/demo?integration=dynamics&dynamics-app-id=3e85abbb-9a1b-4ec3-8a40-1383fe5c103a&dynamics-org-id=e943541f-c234-f011-9a41-6045bd003911&dynamics-org-url=https://m-e943541f-c234-f011-9a41-6045bd003911.us.omnichannelengagementhub.com&license=Xskn6AwiVgzBcQ&demo=true

  You can find all the parameters in the Dynamics 365 - Copilot service admin center > Channels > Chat - Manage > Select and edit your channel > Chat Widget. The HTML snippet displayed on the right holds the required values.

  • dynamics-app-id
  • dynamics-org-id
  • dynamics-org-url

• ServiceNow https://cobrowse-sdk-js-examples.cbrws.io/web-example/demo?integration=servicenow&service-now-url=https://dev305592.service-now.com&license=Xskn6AwiVgzBcQ&demo=true

  The service-now-url parameter can be used to configure your own service now instance.

• CCAIP

  The ccaip integration requires all of the following query parameters:

  • company-id
  • host
  • jwt

• Amazon Connect

  The amazonconnect integration also supports these query parameters:

  • amazon_id
  • amazon_name
  • amazon_base
  • amazon_snippetid

• Talkdesk http://cobrowse-sdk-js-examples.cbrws.io/web-example/demo?integration=talkdesk&license=rV6E9pfNJkxm8w&talkdesk-touchpoint-id=6924c7bb29684d69ad1c8cd73cf612c4&talkdesk-region=td-us-1

  • talkdesk-touchpoint-id can be used to configure your talkdesk conversation touchpoint.
  • talkdesk-region can be used when hosting your talkdesk instance outside of td-us-1.