Starting and stopping the SDK

Have greater control over when the SDK is running.

Starting the Cobrowse SDK is often done early in your application. However, you have the ability to delay the start of the SDK or programmatically stop the SDK so that it runs only when needed.

Starting the SDK

await CobrowseIO.client();
await CobrowseIO.start();

Advanced usage

Sometimes it is required to run only within an IFrame, and not any containing or parent page. This is supported, but requires passing an extra configuration option when starting Cobrowse. Most implementations should not need to use this. Please contact us if you are unsure.

await CobrowseIO.start({ allowIFrameStart: true });

If you do decide to delay or lazy load the SDK it is important to check if there is a currently active session and if so load and start the SDK right away. Without this check sessions would not continue between navigation or page refreshes as the SDK won't be loaded.

// On page load check if we should start the Cobrowse SDK right away
if (CobrowseIO.currrentSession) {
  await CobrowseIO.client();
  await CobrowseIO.start();

See a full example with the Web SDK in

Automatic registration

By default, when the SDK starts it will register the device to your account and share its connectivity state. This provides the dashboard with a list of devices which are online and ready to connect.

If you don't need to see a list of devices in your dashboard, e.g. your sessions start only using 6-digit codes, then you can stop the SDK from registering the device and its connectivity status by setting the registration option with a value of false.

CobrowseIO.registration = false;

Stopping the SDK

Calling stop() will stop Cobrowse completely and you won't be able to Cobrowse again until you call start(). If you only wish to end a session please use end() method on the Session object.

await CobrowseIO.stop();

Last updated