JOI Documentation – Pipaltree

JOI Chat Widget Integration Documentation

1. Overview

JOI (Join Our Institution) is an AI-powered admissions assistant that helps schools engage with prospective parents. The chat widget integrates seamlessly into your website, allowing visitors to ask questions about admissions, fees, facilities, and more – with intelligent, school‑specific answers.

2. How It Works

The widget loads a floating chat button on your website.
When clicked, it opens a chat window where visitors can type questions.
Questions are processed by JOI’s AI, which uses your school’s knowledge base (FAQs, fee structures, transport info, etc.) to provide accurate answers.
Conversations can be saved, emailed as transcripts, and lead data is automatically captured.

3. Prerequisites

Before you begin, ensure you have:

A JOI account with a registered school.
Your API Key – obtainable from the JOI dashboard (Super Admin → Schools → Copy API Key).
Your School Code – also visible on the dashboard.

4. Basic Integration (One‑Line Script)

Add the following script tag to your website’s HTML, just before the closing </body> tag:

Replace:

YOUR_API_KEY – with your actual API key.
YOUR_SCHOOL_CODE – with your school code (optional but recommended).

The widget will automatically appear as a floating button on the bottom‑right corner of your website.

5. Advanced Configuration

5.1 Custom Widget Colour

The widget colour can be customised per school from the JOI dashboard:

On request available

The widget will instantly reflect the new colour – no script change is required.

5.2 Remove “Powered by Pipaltree” Branding

Branding is automatically hidden for schools with an active Premium subscription. Rs.5000/- Per annum.

The widget will no longer display the “Powered by Pipaltree” line.

5.3 Language Support

The widget supports multiple Indian languages. Visitors can select their preferred language from the chat header. Supported languages include:

English
ಕನ್ನಡ (Kannada)
हिन्दी (Hindi)
தமிழ் (Tamil)
తెలుగు (Telugu)
മലയാളം (Malayalam)

Translations happen automatically via JOI’s translation service.

6. Testing the Widget

You can test the widget using a simple HTML file:

<!DOCTYPE html> <html> <head> <title>Test JOI Widget</title> </head> <body> <h1>JOI Chat Widget Test</h1> <script src=“https://joi.pipaltree.co.in/chat.js“ data-api-key=“YOUR_API_KEY“ data-school-id=“YOUR_SCHOOL_CODE“> </script> </body> </html>

Save the file as test.html and open it in a browser. The chat button should appear. Click it to open the chat window and send a test message.

7. Behaviour & Features

Feature	Description
Floating button	Always visible, opens the chat window on click.
Responsive design	Adapts to mobile and desktop screens.
Session persistence	Chat history is saved locally for 7 days (or until user ends chat).
Lead capture	If a visitor shares contact details or expresses interest, a lead is automatically created in the JOI dashboard.
Email transcript	Users can email the full conversation to themselves.
End chat	Users can manually end the session; all local data is cleared.
Multi‑language	Real‑time translation via JOI’s backend.

8. Customisation (Advanced)

If you need deeper customisation (e.g., change button position, inject custom CSS), you can load the widget script and then override styles. Example:

Note: Overriding internal IDs may break if the widget updates; use at your own risk.

9. Troubleshooting

Issue	Possible Solution
Widget does not appear	Check that the script tag is correctly placed. Verify your API key and school code. Open browser console (F12) for errors.
“Invalid API key” error	The API key is incorrect or the school is inactive. Obtain a fresh key from the dashboard.
Answers seem generic	Ensure your school’s knowledge base (FAQs, fees, facilities) is populated in the JOI dashboard.
Translation not working	Confirm that the language selected is supported. Check network requests for `/translate` endpoint.
Widget colour does not change	Clear your browser cache or use incognito mode. The colour is fetched from the server each time the widget loads.

10. Security & Privacy

All communication between the widget and JOI servers is encrypted via HTTPS.
Session IDs are stored in localStorage; no personal data is collected without user consent.
Conversation transcripts are only retained as configured by the school admin (default: 30 days).
File uploads (if enabled) are scanned for malware and stored securely.

11. Support

For technical support or feature requests:

Email: pipaltree.care@gmail.com
Dashboard: https://joi.pipaltree.co.in
Documentation updates: https://pipaltree.co.in/joi-documentation/