Magento 2 Integration
The Magento 2 integration uses a downloadable Magento module that handles both the chat widget injection and the API bridge. The recommended path is a one-command auto-installer that installs the module and completes the OAuth handshake for you, with no credentials to copy by hand. A fully manual install is also available as an advanced fallback.
Quick Install (recommended)
On the Magento integration page in AIChatVault, go to the Install Connector step. You'll see a one-line command with a Quick Install badge — copy it and run it from your Magento root directory over SSH or your host's terminal (e.g. cPanel Terminal):
Copy the install command
php <(curl -sL https://www.aichatvault.com/installer/magento/<your-secret>). The URL is unique to your agent and pre-filled with your webhook secret — no need to edit it.Run it from your Magento root
app/code/AIChatVault/Connector/, enables the module and registers it with Magento, saves the connector settings (webhook secret, widget script URL, Chatbot ID and the widget switch) and flushes the caches. It is all done in one pass, typically under a minute. No compile step is needed: you do not have to run setup:di:compile, even in production mode.OAuth completes automatically
Connection complete
Advanced: manual installation
If you can't run the one-line installer (e.g. restricted shell access, or you manage deployments through Composer only), you can install the module and connect by hand instead:
Download the module
Install the module
app/code/AIChatVault/Connector/.Enable and run setup
- •
php bin/magento module:enable AIChatVault_Connector - •
php bin/magento setup:upgrade - •
php bin/magento cache:flush
Verify installation
Activate the integration and copy credentials
Enter credentials in AIChatVault
https://yourstore.com) and all four OAuth values, then click Connect Magento Store. AIChatVault verifies the credentials and starts a background product sync.Available actions
| Action | Description |
|---|---|
| Product Search & Recommendations | Searches the Magento catalogue and shows product cards with images, prices, and Add to Cart links. |
| Order Status Lookup | Retrieves order status, tracking info, and purchase history by order number. |
| View Cart | Displays the customer's current cart contents, quantities, and totals. |
| Browse Categories | Browses Magento categories to help the AI find relevant products when keyword search returns no results. |
| Update Customer Profile | Lets signed-in customers update their name or email through chat. |
| Update Billing Address | Lets signed-in customers add or update billing addresses through natural conversation. |
| Compare Products | Shows a side-by-side comparison of up to 4 products the customer is considering. |
| Check Return Eligibility | Checks whether an order is still within your configured return window. Governed by the Return Policy panel on the integration page (return window in days, and any excluded product tags). |
| Check Discount Code | Validates whether a discount or coupon code the customer mentions is currently active. |
| Get Cross-Sell / Related Products | Suggests related products after the customer shows interest in an item. |
Widget injection
The connector adds the AIChatVault chat widget to every storefront page. No theme editing is needed. The widget appears once three settings are saved in Magento Admin under Stores → Configuration → AIChatVault → Connector Settings: Widget Script URL, Chatbot ID and the widget switch. The Quick Install command fills all three in for you.
You can switch the widget on or off at any time from the Magento integration page in AIChatVault. The change reaches your store immediately and the connector clears the page caches, so you do not need to flush the cache yourself.
Product sync
A product sync runs automatically when you first connect. The integration page shows the synced product count and last sync timestamp. Click Sync Products to trigger a manual sync after catalogue updates.
Connector settings in Magento
Open Stores → Configuration → AIChatVault → Connector Settings. The Quick Install command sets these for you; you only need them for a manual install:
- Webhook URL: where product changes are sent. The default is correct for most stores.
- Webhook Secret: the secret shown on the AIChatVault Magento integration page. It signs every request between the two sides, so both must hold the same value.
- Widget Script URL and Chatbot ID: shown on the same page for manual installs.
After changing a setting by hand, flush the cache in System → Cache Management.
Troubleshooting
- The widget switch shows "The store rejected the Webhook Secret". The secret in Magento differs from the one in AIChatVault, usually because an older value was saved in the Magento admin. Run the Quick Install command again: it resets the secret in Magento to the correct value. Or paste the secret from the integration page into
Webhook Secretand flush the cache. - The widget shows on some pages but not others. Magento is serving an older cached copy of those pages. In System → Cache Management click Flush Cache Storage, or delete the contents of
var/page_cache. If your store uses Redis or Varnish, flush those too. - The integration page says the connector is not found. Check that the module is enabled (
php bin/magento module:status AIChatVault_Connector) and that your store is reachable over HTTPS.
Disconnecting Magento
Clicking Disconnect in AIChatVault removes the stored credentials and clears synced products from the knowledge base. To also remove the widget from your store, disable or uninstall the Magento module via php bin/magento module:disable AIChatVault_Connector.
Was this page helpful?