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
Ask ChattyBox
xWhere should I start if I need a reliable answer from this site?
Start by adding your website URL to ChattyBox. It crawls your content, answers from the pages it finds, and shows visitors the sources behind each response.
iSources3^
Drupal module guide
chattybox.ai
Analytics
chattybox.ai
Home
chattybox.ai
Ask a question...
Powered by ChattyBox
Built for Drupal site owners, agencies, and support teams
Launch a source-cited chatbot without rebuilding your site stack
ChattyBox crawls your existing website, documentation, help center, CMS, or knowledge base, then embeds a chatbot that answers from your own published content instead of generic model memory.
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.
Keep the widget off administrative routes and non-HTML responses automatically.
Use the optional language override or let ChattyBox follow the page and browser language.
1Workflow step
Create a ChattyBox project, connect your public Drupal URL, and test questions from real visitors.
2Workflow step
Add the ChattyBox GitHub VCS repository to your Drupal project and require openstaticfish/chattybox-drupal:^0.1 with Composer.
3Workflow step
Enable the ChattyBox module and open Configuration > Web services > ChattyBox.
4Workflow step
Paste the public widget API key from the Embed tab. The production API endpoint is configured automatically.
5Workflow 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, conversations, and question analytics.
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
Administrative-route guards, HTML-only loading, and escaped data settings keep the integration focused on public pages.
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 links back to the Drupal pages supporting each answer.
Optional: exclude private Drupal flows
The Composer installation needs no theme code. If a site has public checkout, account, or membership routes, a custom module can disable the widget for those requests.
- 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.
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 the Embed tab. The production API endpoint is configured automatically.
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.03CMS AI chatbotSee how ChattyBox fits CMS-powered websites when Drupal is one part of a larger content stack.04Widget customizationConfigure appearance, language behavior, and source-cited visitor conversations.
FAQ
Common questions
1
What does the ChattyBox Drupal module do?
It adds the maintained ChattyBox widget to public Drupal HTML pages and supplies the public project key and managed production endpoint. ChattyBox handles crawling, retrieval, answers, citations, and analytics.
2
Do I need to edit my Drupal theme?
No. Composer installs the module and Drupal loads its declared library on eligible public HTML routes. No theme template edits are required.
3
Does the module copy or sync my Drupal content?
No. The module does not copy content into Drupal. Connect your public Drupal URL in ChattyBox, then refresh the crawl from the ChattyBox dashboard when published content changes.
4
Can I keep chat off checkout or account routes?
Yes. Administrative routes and non-HTML responses are skipped automatically. Use hook_chattybox_load_widget_alter() for public checkout, account, or membership routes that should not show the widget.
Start free
No credit card required. Your content is not used for model training.
Create free chatbot
Free tier. No card needed.