Getting Started

Read the documentation here on how to use Car Buddy Chat.

To install Car Buddy on your website, please follow the instructions below to import the script and customise your chat assistant. Customisation options can be found below.

Installation

Instructions for installing the Car Buddy Chat javascript library.

Embed script

The following code snippet shows how to embed the chatbot script into your website.

Javascript:

<script src="https://carbuddychat.s3.eu-west-1.amazonaws.com/bundle.js" defer></script>
<script>
  window.addEventListener("load", () => {
    window.initializeChatbot();
  });
</script>

Configuration

The Car Buddy app has a number of options that can be configured to suit your needs. These options can be defined by passing an object of parameters to initializeChatbot();.

For example:

initializeChatbot({
// Your options here
});

Available Options

Car Buddy has the following options:

Theme - Define a theme for the chat assistant. The theme can be any hex colour value.
The default theme is #434A54.

Rep - Define the chat assistant's name.
The default name is Nikki.

Title - Define the chat assistant's title.
The default title is Car Buddy Chat.

Image - Define an image for the chat assistant. Please use a link to the image with the full https:// prefix

Example

A full configuration may be specified as follows:

window.initializeChatbot({
    theme: '#434A54',
    rep: 'Nikki',
    title: 'Car Buddy Chat',
    image: 'https://example.com/image.jpg'
});