Joomla
Install the free ASE system plugin on Joomla 4, 5 or 6: no template edits, page context, and on HikaShop or VirtueMart shops catalogue search, cart and order status.
Before you start
You need a widget key for this site. Create one under Keys & Embed after adding your domain. The key looks like pk_… and is safe to use on public pages; it only works on the domains you registered.
Install the ASE plugin (recommended)
The free System - ASE Support plugin (GPLv2+, Joomla 4.2+, 5 and 6, PHP 7.4+) adds the widget to every site page through Joomla's Web Asset Manager: no template files, no Custom module. It never loads in the administrator. On HikaShop and VirtueMart shops it also connects the agent to your catalogue, the visitor's cart and order status; see below.
- Download plg_system_asesupport.zip (version 1.2.0, admin in 9 languages).
- In your Joomla administrator go to System → Install → Extensions, drag the zip onto the Upload Package File tab (or browse for it). Joomla installs it in a few seconds.
- Go to System → Manage → Plugins, search for ASE and open System - ASE Support.
- Paste your widget key, set Status to Enabled and click Save & Close. Leave API base URL as
https://app.ase.support. - If you use page caching (System - Page Cache plugin or Global Configuration → System → Cache), clear it once under System → Clear Cache.
Plugin options
- Show the widget for: everyone, guests only or logged-in users only.
- Hide on these menu items: pick menu items where the chat should not appear, for example a landing page.
- Send a page text excerpt: on by default. The first 1200 characters of the page (article, contact page, category list) go with the context, so the agent can answer questions about the page the visitor is reading. Forms and scripts are stripped.
- Send the logged-in user's name: off by default. When on, the agent can greet a logged-in user by their display name; no e-mail address or other account data is sent.
Updates arrive through Joomla's own update system (System → Update → Extensions). Disabling the plugin removes the widget; uninstalling it removes the plugin files and its options. Multilingual sites need one plugin configuration; the agent follows the visitor's language.
What the agent knows on a Joomla site
- The site name, content language, page title, URL, active menu item and page type (for example
content/articleorcontact/contact), so it can say where the visitor is and answer about the page. - Everything else comes from your knowledge base and intents in the panel; see Knowledge base.
HikaShop and VirtueMart shops
When HikaShop (4+) or VirtueMart (4.x) is installed, the plugin detects it automatically; nothing to configure beyond the two shop options below. The agent then gets, read only and through the shop's own classes:
- Product on the page: name, SKU, brand, category, price including tax (sale and regular price), stock and a short description.
- Catalogue search: for every product question the ASE service extracts keywords (in the visitor's language and in the shop language), the plugin searches names, SKUs, descriptions and categories and the agent answers from the results only, never from memory. Variants are grouped under their parent product.
- Cart: lines, quantities and the items total including tax, so "what is in my cart?" gets a real answer.
- Orders (option Shop: customer orders and guest order lookup, on by default): a logged-in customer's last five orders with status, total, date, shipping method and tracking number; a guest can ask about an order by giving the order number and the billing e-mail, both must match, 10 lookups per hour per visitor.
- Shop: products per search (default 5, 1 to 20) limits how many products the agent receives.
The two endpoints the chat uses are same-origin com_ajax calls (index.php?option=com_ajax&plugin=asesupport&group=system&format=raw&task=search and …task=order), public and read only; they return the same catalogue data the storefront shows. Demo: joomla.ase.support runs both shops with sample data.
Privacy
The widget script is loaded from the ASE service and the visitor's browser sends chat messages and the page context above to it. Nothing is sent from your server. Details: Privacy Policy. If you publish a privacy policy on your site, mention ASE as the chat provider.
Alternative: the one-line snippet
If you cannot install extensions, use the snippet shown under Keys & Embed:
<script src="https://app.ase.support/widget/ase.js" data-key="pk_YOUR_KEY" defer></script>
- Go to System → Site Templates, open your template, open
index.phpand paste the snippet just before</body>. Save. - Or create a Custom module with the snippet (switch the editor to code view so the tag is not stripped) and assign it to a footer position on all pages.
The snippet gives you the chat without the page context; do not use both methods at once.
Check
- Open the site in a private window; the chat bubble appears in the corner you chose in Agent Settings.
- Ask "which page am I on?": with the plugin the agent names the page.
- If the answer is generic, assign a knowledge base category to the agent under Agent Access. If nothing appears, see troubleshooting.
For developers
- The plugin listens to
onBeforeCompileHeadand registers the widget script as the web assetplg_system_asesupport.widget; the page context is printed aswindow.__aseJoomla. - Source and issues: plg_system_asesupport.zip (GPLv2+). Contact support for feature requests.