Show Developer Menu

Shoutbox Integration

Contact Mode

To get started with Reamaze Embedding, the basic integration will provide you with a help shoutbox that allows your customers to contact you, creating new conversations in your Reamaze support channel. If you have Live Chat enabled on your account, the default shoutbox will also provide users with the Live Chat experience.

Widget basic

Installation

Make sure you have the Reamaze.js snippet installed from the Installation Step.

<script type="text/javascript">
  _support['ui']['widget'] = true;
</script>

Copy and place the above code anywhere in your HTML.

Self Service Mode

By default, the shoutbox will load with a contact form. If you'd like the shoutbox to display your Knowledge Base Articles and Search first, you can simply toggle the mode.

Widget mode

Installation

<script type="text/javascript">
  _support['ui']['widget'] = true;
  _support['ui']['lightbox_mode'] = "kb";
</script>

Copy and place the above code anywhere in your HTML.

Customizing Shoutbox Colors and Text/Language

You can personalize your Brand's Reamaze.js shoutbox without touching any code! You'll just need to go to Brand Settings to adjust your preferences. The shoutbox will then load with your selected color and text settings.

Custom Contact Form Fields

Your shoutbox contact form can also display custom fields like text boxes and dropdowns. When your customers enter values in these custom fields, they'll be displayed along with the submitted conversation within Reamaze. Documentation for this is covered in Custom Form Fields

Forcing Messages to a Specific Channel

Your Reamaze Account can manage multiple channels. For example, you might have a channel for "Support" and another for "Sales". By default, the customer will be given the option to select amongst Visible channels for their message. You can also force a specific channel using the following.

<script type="text/javascript">
  _support['ui']['mailbox'] = "{{ CHANNEL }}";
</script>

Copy and place the above code anywhere in your HTML.

Replace {{ CHANNEL }} with the desired Channel ID from your Account. You can find your Channel ID values under Account IDs and Secret from within your Account Settings.

Next Step

If you'd like to customize the shoutbox trigger, you can do so with a snippet of JavaScript.

Next: Shoutbox Trigger Customization →