Documentation

Live Chat documentation

Install the widget, configure it, and start chatting with visitors. Most setups take under 10 minutes.

Installation

5 min read

Configuration

10 min read

Dashboard

8 min read

API Reference

Full API docs

Widget Installation

Add the chat widget to your website with a single script tag.

Create a Widget

Go to Dashboard

Add the Script

Copy and paste this code snippet into your website's <head> or before the closing </body> tag.

<script>
  (function() {
    var script = document.createElement('script');
    script.src = 'https://cdn.stackbloom.com/widget.js';
    script.async = true;
    script.onload = function() {
      StackBloomChat.init({
        widgetId: 'YOUR_WIDGET_ID',
        position: 'bottom-right',
        primaryColor: '#3B82F6'
      });
    };
    document.head.appendChild(script);
  })();
</script>

Test Your Widget

Visit your website to see the chat widget appear. Click it to send a test message and verify everything is working correctly.

Configuration options

Control how the widget looks and behaves.

Option	Type	Description
`widgetId`	string	Your unique widget identifier (required)
`position`	string	Widget position: 'bottom-right', 'bottom-left'
`primaryColor`	string	Widget theme color (hex format)
`greeting`	string	Custom greeting message
`userInfo`	object	Pre-fill user data (name, email, customData)
`showWhenOffline`	boolean	Display widget even when agents are offline

Example:

StackBloomChat.init({
  widgetId: 'widget_abc123',
  position: 'bottom-right',
  primaryColor: '#3B82F6',
  greeting: 'Hi! How can we help you today?',
  userInfo: {
    name: 'John Doe',
    email: 'john@example.com',
    customData: {
      plan: 'pro',
      userId: '12345'
    }
  },
  showWhenOffline: true
});

Using the dashboard

Where you manage conversations, team members, and settings.

Conversations

View and respond to all customer conversations in real-time. Filter by status (open, closed, assigned) and search by customer name or message content.