wagtail-ai-chatbot

Adds the Asyntai AI chat assistant to a Wagtail site. The assistant answers visitor questions from your own content, day and night, in more than 80 languages.

Free and open source. Works on every Asyntai plan, including the free plan.

• Requires Wagtail 5.2 or newer, Django 4.2 or newer, Python 3.9 or newer
• Documentation: https://asyntai.com/documentation/integrations/wagtail/

Install

pip install wagtail-ai-chatbot

Add the app and the settings module to INSTALLED_APPS:

INSTALLED_APPS = [
    "wagtail_asyntai",
    "wagtail.contrib.settings",
    # ...
]

Add the middleware, first in the list:

MIDDLEWARE = [
    "wagtail_asyntai.middleware.AsyntaiWidgetMiddleware",
    # ...
]

Run the migration:

python manage.py migrate wagtail_asyntai

Then open the Wagtail admin, go to Settings → Asyntai chat assistant, and paste your widget ID. You get the ID from your Asyntai dashboard, under Setup & Integration. You can paste the whole snippet; the package keeps only the ID.

That is all. The chat button appears on every page of the site.

Settings in the Wagtail admin

The settings are per site, so a multi-site project can give each site its own assistant.

Settings in your settings file

A project that keeps configuration in environment variables can skip the admin. The admin wins when both are filled in.

ASYNTAI_WIDGET_ID = "asyntai_ab12cd34"
ASYNTAI_SHOW_TO_ANONYMOUS_ONLY = False       # optional
ASYNTAI_SCRIPT_URL = "https://widget.asyntai.com/static/js/chat-widget.js"  # optional
ASYNTAI_SKIP_PREFIXES = ["/admin/", "/django-admin/", "/cms/"]             # optional

ASYNTAI_SKIP_PREFIXES names the paths the widget never touches. Set it when your admin lives somewhere other than /admin/.

Placing the widget by hand

Leave the middleware out and put the tag where you want it instead:

{% load asyntai %}
...
{% asyntai_widget %}
</body>

The tag and the middleware never both fire, so it is safe to keep both.

How it works

The middleware inserts a small script just before the closing body tag of every HTML page. That script waits for the page to finish loading, then fetches the chat widget from Asyntai, so your site draws first and page speed is unchanged.

The widget ID and the script address travel to the browser on a data attribute, never inside the script, so a pasted value cannot break out and run. Only an https address is accepted.

The middleware leaves alone: the Wagtail admin, anything that is not text/html, any status other than 200, a streaming response, a body another middleware has compressed, a page with no closing body tag, and a page that already carries the widget.

Tests

pip install wagtail
PYTHONPATH=src:. python -m django test --settings=tests.settings

50 tests. They cover reading a stored value, the settings screen in the Wagtail admin, the middleware on ten kinds of response, the template tag, and a node --check of the script on the rendered page.

Support

hello@asyntai.com

Licence

MIT. See LICENSE.