Connect a Magento or Adobe Commerce store
Create an integration in your Magento Admin, then enter its four keys and your store's URL on the Magento card under Integrations in the Webscale AI console. Select Create, then the Verify connection icon beside Update. Products, categories, customers, orders and stock then sync every 6 hours by default.
Before you start
Section titled “Before you start”Use this guide to connect a Magento Open Source or Adobe Commerce store so the AI Shopping Assistant and Audience Segmentation work from your live store data. Both editions use the same Magento connector. The Supported platforms and integrations reference lists what each connector syncs.
The Magento connector uses four values from a Magento integration: a consumer key, a consumer secret, an access token and a token secret. Magento shows the access token and token secret when you activate the integration. Keep the console and your Magento Admin open in separate tabs while you work.
Start the connection in the console
Section titled “Start the connection in the console”Start the connection in the console
- In the Webscale AI console, open the account menu under your name at the bottom of the sidebar and select Integrations.
- On the Magento card, select Connect. The Magento Connection page opens.
- In the Webscale AI console, open the account menu under your name at the bottom of the sidebar and select Integrations.
- On the Magento card, select Connect. The Magento Connection page opens.
Create the integration in Magento
Section titled “Create the integration in Magento”- In your Magento Admin, go to System > Integrations and select Add New Integration.
- On the Integration Info tab, enter a Name, such as Webscale AI. Leave Callback URL and Identity link URL empty. Enter your Magento Admin password in Your Password.
- On the API tab, set Resource Access to All. If your store’s policy requires Custom, select every area listed under Integration access. Select Save.
- In the integrations list, select Activate next to the new integration, then Allow. Magento shows the consumer key, consumer secret, access token and token secret. Copy all four.
Enter the keys in the console
Section titled “Enter the keys in the console”Enter the keys in the console
- Back on the Magento Connection page, enter your store's REST API address in API base path. A bare domain fails verification.
- Paste the four values from Magento into Consumer Key, Consumer Secret, Access Token and Token Secret. Each field is masked.
- Select Create. The page shows Connector created successfully! and stays open as Update Magento Connection.
- Select the Verify connection icon beside Update. A bar at the top of the page shows Connection verified when Webscale AI can reach your store. If verification fails, the reason shows next to the icon.
- Back on the Magento Connection page, enter your store’s REST API address in API base path. A bare domain fails verification.
- Paste the four values from Magento into Consumer Key, Consumer Secret, Access Token and Token Secret. Each field is masked.
- Select Create. The page shows Connector created successfully! and stays open as Update Magento Connection.
- Select the Verify connection icon beside Update. A bar at the top of the page shows Connection verified when Webscale AI can reach your store. If verification fails, the reason shows next to the icon.
The REST API address takes the form https://your-store.com/rest/default/V1. Replace your-store.com with your domain and default with your store view code.
The Magento Connection page also links to a setup guide, which isn’t available. The steps above cover the whole connection. The page also asks you to install the Webscale extension. That extension is optional, as described in Link signed-in shoppers to their browsing.
Once the connection is verified, Webscale AI syncs products, categories, customers, orders and stock levels from your store.
Integration access
Section titled “Integration access”Webscale AI reads your store through the Magento integration. It changes orders only when Allow write actions is on for Order & Returns Management. With Custom resource access, select these areas so every feature works.
| Area in the API tab’s resource tree | What Webscale AI uses it for |
|---|---|
| Stores > Settings > All Stores, and Stores > Attributes > Product | Verifying the connection, reading store views and attribute labels |
| Catalog > Inventory > Products and Categories | Syncing your catalog |
| Stores > Inventory > Sources and Stocks | Syncing stock levels |
| Customers > All Customers | Syncing customers and checking a shopper’s identity before order details are shared |
| Sales > Operations > Orders, including Cancel, Invoice, Ship, Credit Memos and Comment under Actions | Syncing orders and answering order questions. Changes need Allow write actions |
| Returns, on Adobe Commerce | Starting returns through Order & Returns Management. Needs Allow write actions |
Check that it worked
Section titled “Check that it worked”The Magento connection is working when all three of these are true:
- The Magento Connection page showed Connection verified after you selected Verify connection.
- On the Integrations page, the Magento card shows a Connected badge and its button reads Update connection.
- Under Settings > Data > Product catalog sync, the Status badge shows Completed with a time next to Last synced at:.
The first sync can take a while on a large catalog. While it runs, the Status badge shows Syncing.
Change the sync schedule
Section titled “Change the sync schedule”Webscale AI syncs a Magento store every 6 hours by default. Each sync brings in only what changed since the last one. You can run a sync right away or set your own schedule.
- Go to Settings > Data > Product catalog sync.
- To sync now, select Sync now. The button reads Syncing… while the sync runs.
- To set a schedule, select Create Schedule in the scheduling card, or Edit Schedule if one exists.
- Choose a Schedule Type of Hourly, Daily, Weekly or Monthly. Then set the time and timezone and save the schedule.
The scheduling card shows “No schedule configured” until you save a schedule of your own. The default sync still runs every 6 hours while the card shows that message.
Track shopper behavior on your site
Section titled “Track shopper behavior on your site”The Magento connector syncs store data. Shopper behavior on your site comes from Onsite Tracking, which Audience Segmentation uses to build segments.
- On the Integrations page, select Connect on the Onsite Tracking card.
- Select Copy to copy the script. Add it to your site’s main template, before the closing
</body>tag. - Select Verify. The button reads Verified when Webscale AI finds the script on your site.
Link signed-in shoppers to their browsing
Section titled “Link signed-in shoppers to their browsing”The Webscale EventStream extension is an optional Magento module. When a shopper signs in to your store, it tells Webscale AI, so the browsing that Onsite Tracking recorded before the sign-in joins that shopper’s customer profile. Audience Segmentation then sees one shopper instead of an anonymous visitor and a customer. The connection and the catalog sync work without it. Install it after Onsite Tracking is on your site.
- In your Magento root folder, add the extension’s repository to Composer:
Terminal window composer config repositories.webscale-magento-eventstream git https://github.com/webscale-networks/magento-eventstream.git - Install the extension:
Terminal window composer require webscale-networks/magento-eventstream - Enable the module and refresh Magento:
Terminal window php bin/magento module:enable Webscale_EventStreamphp bin/magento setup:upgradephp bin/magento cache:clean - In your Magento Admin, go to Stores > Configuration > Webscale > Event Stream. Set Enable to Yes and select Save Config.
The extension only reports sign-ins. It adds no script to your storefront.
Troubleshooting
Section titled “Troubleshooting”| Problem | Fix |
|---|---|
| Verification fails with “Invalid OAuth credentials” | Check that the integration is active in your Magento Admin. Paste the four values again so none has extra spaces |
| One type of data doesn’t sync, such as orders or stock | With Custom resource access, check that the integration includes that area under Integration access. Then select Sync now |
| Verification still fails with the right values | Check that API base path is the full REST API address ending in /rest/<store code>/V1. Then select Update and the Verify connection icon again |
| You changed the integration in Magento | On the Integrations page select Update connection on the Magento card. Enter the new values and select Update. Then select the Verify connection icon |
| Product catalog sync shows Failed | Select Sync now to try again. Contact Webscale support if it fails a second time |
| The scheduling card says “No schedule configured” | Nothing is wrong. The default sync runs every 6 hours. Create a schedule only to change the timing |
| Onsite Tracking shows “Website tracking is not enabled.” | Check that the script is in your main template before the closing </body> tag and that the change is live on your site. Then select Verify again |
| You need to stop syncing | Open the connection page and select Disconnect. Type “disconnect” to confirm. This removes the connection and the keys stored for it |
Frequently asked questions
- Does Adobe Commerce use a different connector from Magento Open Source?
- No. Magento Open Source and Adobe Commerce use the same Magento connector in the Webscale AI console. Follow the same steps for either edition.
- How often does Webscale AI sync my Magento store?
- Every 6 hours by default. Each sync brings in only what changed since the last one. You can start a sync or set your own schedule under Settings > Data > Product catalog sync.
- Does the Magento connector track what shoppers do on my site?
- No. Shopper behavior on your storefront comes from Onsite Tracking, a separate card under Integrations. Onsite Tracking needs a script on your site.
- Do I need the Webscale extension for Magento?
- No. The connection and catalog sync work without it. The optional Webscale EventStream extension links a shopper's browsing to their customer profile when they sign in to your store.
- What does Disconnect do?
- Disconnect removes the Magento connection and the keys stored for it. Webscale AI stops syncing your store until you connect it again.
- Which URL do I enter in API base path?
- Enter your store's full REST API address, in the form https://your-store.com/rest/default/V1. Replace your-store.com with your domain and default with your store view code. A bare domain fails verification.