Documentation

Getting started

Pick your integration. We'll have you sending messages in under 10 minutes.

1. Create your workspace

2. Get your organization ID

Visit Admin → Widget. Your orgId is shown at the top of the page.

Pro tip

Treat your orgId as public — it's safe to expose in client-side code. Bot tokens, webhook secrets, and supervisor tokens must be kept private.

3. Embed the widget

Paste the snippet below into the <head> of your website:

index.html

<!-- BXLivechat widget -->
<script>
  window.__bxlivechat = {
    orgId: "YOUR_ORG_ID",
    visitor: {
      // Optional: pre-fill visitor info (e.g. from your auth)
      name: "John Doe",
      email: "[email protected]",
    },
    customData: {
      // Optional: any data you want to pass to agents
      plan: "pro",
      cartValue: 123.45,
    },
  };
  (function(d,s){
    var j = d.createElement(s);
    j.src = "https://widget.bx-livechat.com/bxlivechat.js";
    j.async = true;
    d.head.appendChild(j);
  })(document,"script");
</script>

4. (Optional) Build a bot

Visit Admin → Agents → Add agent → role: CHATBOT. Copy the API token shown once.

terminal

curl https://app.bx-livechat.com/api/bot/chats \
  -H "Authorization: Bearer YOUR_BOT_TOKEN"

Save your token

The bot API token is shown once after creation. If you lose it, you must regenerate it from the Agents page.

Overview Bot API