Skip to content

austial/ai-chatbot-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

Austial Chatbot Widget

A lightweight, customizable React chatbot component that seamlessly integrates with the Austial platform for AI-powered customer conversations.

npm version License: MIT

Chatbot Preview

Chatbot Preview 1

Dashboard Preview

Chatbot Panel Preview

Features

  • Easy Integration - Use as npm package or script tag
  • Cloud-Configured - All settings managed via Austial dashboard
  • Responsive Design - Works seamlessly on all devices
  • Secure - API key authentication with configurable security settings

Prerequisites

Before using this widget, you need to:

  1. Sign up at Austial
  2. Create a chatbot in your Austial dashboard
  3. Get your credentials:
    • Business ID
    • API Key

All chatbot configurations (appearance, behavior, knowledge base, AI instructions, etc.) are managed through the Austial dashboard.

Installation

NPM (React Applications)

npm install @austial/chatbot-widget

Script Tag (Any Website)

<script src="https://unpkg.com/@austial/chatbot-widget@latest/dist/austial-chatbot.iife.js"></script>

Quick Start

React Usage

import { Chatbot } from '@austial/chatbot-widget'
import '@austial/chatbot-widget/dist/style.css'

function App() {
  return (
    <Chatbot
      config={{
        businessId: 'your-business-id',
        apiKey: 'your-api-key',
      }}
    />
  )
}

HTML/JavaScript Usage

<!DOCTYPE html>
<html>
  <body>
    <h1>My Website</h1>

    <script src="https://unpkg.com/@austial/chatbot-widget@latest/dist/austial-chatbot.iife.js"></script>
    <script>
      window.AustialChatbot.init({
        businessId: 'your-business-id',
        apiKey: 'your-api-key',
      })
    </script>
  </body>
</html>

Configuration

The widget only requires two parameters:

{
  businessId: string // Your unique business identifier from Austial
  apiKey: string // Your API key from Austial dashboard
}

All other configurations are managed through your Austial Dashboard:

Dashboard Configuration Options

  • Business Information - Name, description, branding
  • Chatbot Settings - Bot name, avatar, welcome message, placeholder text
  • UI Interface - Colors, position, themes, styling
  • Knowledge Base - Upload files and documents for AI training
  • AI Instructions - Custom prompts and behavior rules
  • Security - Access control, rate limiting, domain restrictions
  • Analytics - Conversation insights and performance metrics

Austial Platform

The widget connects to the Austial platform to:

  • Fetch your chatbot configuration automatically
  • Process user messages with AI
  • Store conversation history
  • Apply your custom knowledge base
  • Enforce security settings

Visit www.austial.com to:

  • Create and manage chatbots
  • Configure appearance and behavior
  • Upload knowledge base files
  • Customize AI instructions
  • View analytics and conversations
  • Manage API keys and security

Methods

Initialize

window.AustialChatbot.init({
  businessId: 'your-business-id',
  apiKey: 'your-api-key',
})

Destroy

window.AustialChatbot.destroy()

Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

TypeScript

Full TypeScript definitions are included:

import type { ChatbotConfig, Message } from '@austial/chatbot-widget'

Support

License

MIT © Austial

About

Austial Chatbot: AI Powered AI Chatbot for Businesses and Customer Support

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors