https://github.com/mavenagi-apps/chatbot

A basic chat Maven App
https://github.com/mavenagi-apps/chatbot

surface

Last synced: about 1 month ago
JSON representation

A basic chat Maven App

• Host: GitHub
• URL: https://github.com/mavenagi-apps/chatbot
• Owner: mavenagi-apps
• License: apache-2.0
• Created: 2024-11-13T12:31:12.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-03T14:36:58.000Z (about 1 month ago)
• Last Synced: 2024-12-03T15:39:08.826Z (about 1 month ago)
• Topics: surface
• Language: TypeScript
• Homepage: https://mavenagi-developer-app-production-chatbot.magiapps.net
• Size: 241 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
This Maven App provides a chat widget that can be embedded on a website. It uses [Maven APIs](https://developers.mavenagi.com) to answer questions and provide feedback.

This Chat provides the original Maven UI and experience.

It is being replaced by Chat v2 which has additional features and security.

# Installation

- Install the `chat` app via Agent Designer

  - Navigate to the Agent Designer [dashboard](https://app.mavenagi.com/dashboard)

  - Select `Apps` \> `App Directory` \> `Browse & Install`

  - Install the official `Chat` app (created by Maven AGI)

  - Provide the required settings, including the logo URL and brand color hex code

# Deploying the App Via JS Widget

1. Include the below javascript to install the chat widget on your website.

```

```

3. Initialize the widget and provide configuration settings:

```javascript

  addEventListener("load", function (){" "}

  {Maven.ChatWidget.load({

    organizationId: "<orgId>",

    agentId: "<agentId>",

    location: "bottom-left",

    tag: "help-center",

  })}

  );

```

Your organizationId can be found on the Organization Profile page within Agent Designer.

And your agentId can be found on the Agents page.

## Configuration Options

```typescript

interface WidgetConfig {

  bgColor?: string; // Widget background color

  textColor?: string; // Widget text color (default: 'white')

  location?: "bottom-left" | "bottom-right"; // Widget position (default: 'bottom-right')

  tag?: string; // A tag to be used on all conversations

  organizationId: string; // Required: Your organization ID

  agentId: string; // Required: Your agent ID

}

```

You can manually open and close the chat widget using the following methods:

`Maven.ChatWidget.open()`

`Maven.ChatWidget.close()`

You can set the location of the chat button on your website using the following values: 'bottom-left' or 'bottom-right'.

## Previewing the widget in fullscreen

Once installed, the app is available at `https://chat.onmaven.app/en///preview`.

This is the URL that gets iframed when the app is rendered as an embedded widget.