01
Composer-managed install
Register the public VCS repository once, require the tagged module, and keep updates in your Drupal project workflow.
ChattyBox Drupal Module
Add source-cited AI support to your Drupal site
Install the ChattyBox Drupal module with Composer to add a source-cited AI chatbot to public Drupal pages without editing theme templates or building a custom RAG stack.
Crawls published docs pagesSource-cited answersEmbeds with one scriptNo docs migration requiredNo credit card requiredYour content stays yours
Current distribution
Install the tagged module from public GitHub
ChattyBox is not yet listed on Drupal.org or Packagist. Add the GitHub VCS repository before requiring openstaticfish/chattybox-drupal:^0.1; directory-managed updates are not available yet.
The audited automatic module loader does not check visitor consent before loading. If consent is required, use a consent-aware integration that prevents loading until consent is granted instead of enabling the automatic loader. See the Drupal setup guide and verify revocation with the deployed loader.
Launch a source-cited chatbot without rebuilding your site stack
ChattyBox crawls your existing website, documentation, help center, CMS, or knowledge base. Retrieved content can guide the chatbot’s answers; check answers and citations for accuracy.
Install the maintained module through Composer instead of copying files or editing theme templates.
Answer from the public Drupal content you choose, including pages, docs, FAQs, and knowledge bases.
The audited module skips administrative routes and requests whose Drupal request format is not HTML; it does not check the final response Content-Type or page privacy.
Follow the project locale policy, or set a language override when the project permits script overrides.
Workflow step
Create a ChattyBox project, connect your public Drupal URL, and test questions from real visitors.
Workflow step
Add the ChattyBox GitHub VCS repository to your Drupal project and require openstaticfish/chattybox-drupal:^0.1 with Composer.
Workflow step
Enable the ChattyBox module and open Configuration > Web services > ChattyBox.
Workflow step
Paste the public widget API key from Install > Website installation. Compare the module’s hard-coded API endpoint with the snippet; use manual installation if they differ.
Workflow step
Enable the chatbot and verify the launcher, answer quality, and source citations on a public page.
Three-step launch
Paste your Drupal module URL, test cited answers, then install the widget.
Composer-first Drupal setup
A clean boundary between Drupal and ChattyBox
Composer manages the module code, Drupal manages configuration and page rendering, and ChattyBox handles crawling, retrieval, source citations, and conversations; question analytics is included on Pro and Business.
Decision path
Use these checkpoints to decide whether ChattyBox should sit beside your docs platform, replace a separate assistant, or stay isolated for testing.
02
One settings screen
Configure the public widget key, loader URL, language behavior, and frontend enablement from Configuration > Web services > ChattyBox.
03
Public-content grounding
Connect the public Drupal URL in ChattyBox and keep Drupal’s existing publishing workflow as the source of truth.
04
Safer frontend loading
The audited module uses escaped data settings and skips administrative routes and non-HTML Drupal request formats, but does not check final response Content-Type or frontend page privacy.
The integration boundary
Composer installs. Drupal publishes. ChattyBox answers.
Keep the responsibilities clear: Composer owns the module lifecycle, Drupal remains the public content source, and ChattyBox turns that content into a tested, cited support experience.
With Composer
Install and update
Register the public GitHub repository, require the module, and keep releases inside the Drupal project workflow.
In Drupal
Configure public pages
Enable the module, paste the public project key, and choose the language behavior from the Drupal configuration form.
For visitors
Answer with context
Visitors get a floating chat experience that can link back to supporting Drupal pages. Some answers, including fallbacks, may have no sources.
Optional: exclude private Drupal flows
The Composer installation needs no theme code. The module does not check page privacy; use a custom module to exclude checkout, account, or membership routes where appropriate, and verify cache variation and invalidation for the exclusion.
- 1Install and configure the module first so the default public-page behavior is working.
- 2Implement hook_chattybox_load_widget_alter() in a custom module when a route should not show chat.
- 3Test the excluded route and a normal public page in an incognito window, with Drupal and intermediary caches both warm and cold.
mymodule.module
php
<?php
/**
* Implements hook_chattybox_load_widget_alter().
*/
function mymodule_chattybox_load_widget_alter(&$should_load, $config, $route_match) {
if ('commerce_checkout.form' === $route_match->getRouteName()) {
$should_load = FALSE;
}
}Install path
Install the Drupal module with Composer
Register the public GitHub repository, require the tagged module, and enable it in Drupal. No theme code is required.
- 1Add the ChattyBox GitHub VCS repository to your Drupal project and require openstaticfish/chattybox-drupal:^0.1 with Composer.
- 2Enable the ChattyBox module and open Configuration > Web services > ChattyBox.
- 3Paste the public widget API key from Install > Website installation. Compare the module’s hard-coded API endpoint with the snippet; use manual installation if they differ.
Terminal
sh
composer config repositories.chattybox-drupal vcs https://github.com/OpenStaticFish/chattybox-drupal.git
composer require openstaticfish/chattybox-drupal:^0.1
drush en chattybox -yExplore next
More ways to use ChattyBox
01Drupal module setup guideRegister the VCS repository, install with Composer, configure the module, and verify public routes.02Widget installation referenceReview the public key, language, and verification requirements behind the module.03Website AI ChatbotAdd a source-cited AI chatbot to public websites, about pages, product pages, help centers, and documentation.04Widget customizationConfigure appearance, language behavior, and source-cited visitor conversations.
FAQ
Common questions
1
Is ChattyBox listed on Drupal.org or Packagist?
Not yet. The tagged module is currently distributed from the public ChattyBox GitHub repository, so Composer needs the documented VCS repository entry before requiring it. Drupal.org and Packagist update discovery are not available yet.
2
What does the ChattyBox Drupal module do?
The audited module attaches the ChattyBox widget on eligible non-admin requests with an HTML Drupal request format, using the public widget key and a hard-coded API endpoint. Compare that endpoint with the installation snippet and use the manual integration if they differ. ChattyBox handles crawling, retrieval, answers, and citations; analytics is included on Pro and Business.
3
Do I need to edit my Drupal theme?
No. Composer installs the module and Drupal attaches its declared library on eligible non-admin requests with an HTML Drupal request format. No theme template edits are required.
4
Does the module copy or sync my Drupal content?
No. The module only loads the widget; it does not crawl or synchronize Drupal content. Connect your public Drupal URL in ChattyBox, then refresh the crawl from the ChattyBox dashboard when published content changes.
5
Can I keep chat off checkout or account routes?
Yes. The audited module skips administrative routes and non-HTML Drupal request formats, but does not check frontend page privacy. Use hook_chattybox_load_widget_alter() for checkout, account, or membership routes that should not show the widget, and verify cache variation and invalidation.
Start free
No credit card required
Create free chatbot
Free tier. No card needed.