<aside> 💡 If you would like to see any of the Roadmap features, something else or have feedback on the existing API, reach out to Liam.

</aside>

The Web SDK allows you to control the launcher bubble from the global JavaScript object $botbrains.

The SDK is shipped by default and in public beta and the API will be expanded based on user needs. See Roadmap.

Prerequisite

<aside> 💡

The SDK is NOT supported if you use the deprecated iFrame integration. Use the launcher and benefit from all new features.

</aside>

The SDK will assume you run the code via the launcher integration.

<script type="text/javascript">
  $botbrains = [];
  $botbrains.push(["set", "config", {
      frameId: 'YOUR_FRAME_ID',
  }]);
  (function(){d = document;s = d.createElement('script');s.src = '<https://chat.botbrains.io/loader.js>';s.type = 'module';s.async = 1;d.getElementsByTagName('head')[0].appendChild(s);})();
</script>

Use Cases

Hide Launcher on specific pages

// Check if the current page matches a specific URL
if (window.location.pathname === "/specific-page") {
  $botbrains.push(["do", "chat.hide"]);
}

Hide Launcher on small devices

// Check the screen width and hide the launcher if the width is below a threshold (e.g., 600px)
if (window.innerWidth < 600) {
  $botbrains.push(["do", "chat.hide"]);
}

Integrated Product Help - Buttons

<button
  onclick="$botbrains.push(['do', 'message.send', 'How does Feature XY work?'])"
>
  Get Help
</button>

Annotate User Data

const data = {
	first_name: "Liam",
	last_name: "van der Viven",
	email: "[email protected]",
	phone: "+4915168433056",
	external_attributes: {
		"plan": "business", 
	}
};
$botbrains.push(["set", "user.data", data]);

Identify Users

We also support identifying users against our system. Please talk to [email protected] for get an introduction.