API Reference

VueBotConfig Interface

interface VueBotConfig {
  // Required
  apiKey: string;
  
  // Optional
  apiBaseUrl?: string;
  position?: 'bottom-right' | 'bottom-left';
  primaryColor?: string;
  secondaryColor?: string;
  botName?: string;
  botAvatar?: string;
  greetingMessage?: string;
}

Configuration Properties

apiKey

Type: string

Required: Yes

Your VueBot API key. Get one from vuebot-client.vuedapt.com

apiBaseUrl

Type: string

Required: No

Default: 'https://vuebot-api.vuedapt.com'

The base URL for the VueBot API.

position

Type: 'bottom-right' | 'bottom-left'

Required: No

Default: 'bottom-right'

Position of the chat button on the screen.

primaryColor

Type: string

Required: No

Default: '#00a6f4'

Primary color for the widget. Accepts any valid CSS color value.

secondaryColor

Type: string

Required: No

Default: '#00bcff'

Secondary color for the widget. Accepts any valid CSS color value.

botName

Type: string

Required: No

Default: 'Chat Assistant'

The name of your chatbot displayed in the chat header.

botAvatar

Type: string

Required: No

URL to the bot's avatar image. If not provided, a default avatar is used.

greetingMessage

Type: string

Required: No

A greeting message that appears when the chat is first opened.