Skip to main content

General Settings

The eChat configuration is located at Stores > Configuration > Mirasvit Extensions > eChat.

Account​

The Account section manages your store's connection to the eChat cloud platform. Before you connect, it offers two tabs; once connected, it shows the workspace credentials and the actions below.

Tab / ActionDescription
Connect → Connect with eChatOpens the eChat consent screen in a new tab, where you choose to create a new workspace, add this store to an existing eChat account, or restore a workspace you set up earlier. No OpenAI API key is required.
Restore with credentialsReconnects an existing workspace using its Instance ID and Secret Key - used when moving a store to a new domain.
Reset RegistrationDisconnects this store from its eChat workspace, and removes the workspace on the eChat side. At website or store-view scope the action is called Reset to Global Account and returns that scope to the global workspace instead.
Instance ID / Secret KeyThe connected workspace's credentials. The secret key is masked; click it to reveal. The secret key is also the REST API token.
note

Every store view of a Magento installation is grouped under one eChat account automatically, so each connected store view appears under a single, recognizable account rather than as an unrelated workspace. The grouping is managed in the backend, on the Workspaces tab.

Per-store-view workspaces

By default a store view inherits the global workspace, and the panel says so. To give a store view its own workspace - a separate knowledge base, separate settings, separate conversations - switch the configuration scope to that store view and click Switch to Separate Account. Once several store views have their own workspaces, the default-scope panel lists them under Store-Level Overrides, each with its own Configure Chat button.

Managing registrations requires the Mirasvit_EChat::echat_config ACL resource. An admin without it sees the connection status but no connect, configure, or reset actions.

The full procedure, including the per-store-view sync and where the chat's language comes from, is in How to set up multiple store views and languages.

Configure Chat​

Once your store is connected, use the Configure Chat button to open the eChat platform in a new browser tab. The chatbot's AI provider and model, appearance, behavior, greeting messages, and other widget settings are all managed on the eChat platform - not in the Magento admin. See How to configure the chatbot.

Turning the widget on and off​

There is no on/off switch on this configuration screen. The widget is enabled per workspace in the eChat backend, under Settings > Widget > Enable widget - see Settings.

Two other things can keep the widget off a storefront that is otherwise configured:

  • The page matches Do not load the widget on pages (below).
  • The store has no active Mirasvit license. Since version 1.2.0 the storefront widget requires one; development domains are unaffected, as elsewhere in Mirasvit extensions.

Widget​

  • Do not load the widget on pages - a list of patterns, one per line, marking where the chat widget should not load. Each line is either:

    • a URL fragment - for example, /checkout/ excludes the whole checkout flow; or
    • a Magento page type (full action name) - for example, checkout_cart_index excludes the cart page, and catalog_product_view excludes all product pages.

    On a matching page no widget script is injected and no request is made to the eChat service at all. Leave the field empty to load the widget on every page.

  • Load the widget - when the widget may load, for stores behind a cookie consent banner:

    • Always (default) - on every page.
    • After Cookiebot consent - Cookiebot releases the widget once the visitor accepts the Cookiebot category below.
    • After Magento cookie consent - waits for Allow Cookies in Magento's cookie notice. Needs Cookie Restriction Mode on; with it off the widget loads as usual.
    • After a call from another consent tool - waits until your consent tool calls window.mstEchatConsent().

    Until consent nothing is loaded from eChat and nothing is stored in the browser. Details and code examples: Privacy and GDPR.

  • Cookiebot category - shown for After Cookiebot consent: the Cookiebot category that releases the widget (Preferences, Statistics or Marketing).

Sync Schedule​

The extension automatically syncs your store data - store information, products, categories, CMS pages, and Mirasvit Knowledge Base articles - to the eChat knowledge base using a cron job that runs daily at 2:00 AM.

The schedule is not configurable from the admin: it is declared in the module's etc/crontab.xml as 0 2 * * *. To run the sync at a different time, override that cron job's schedule from your own module.

The sync job, mst_echat_sync, runs in its own cron group, mst_echat, as a separate process, so a long sync on a large catalog does not hold up the jobs in Magento's default group. A plain bin/magento cron:run runs every group, so most stores need no change.

note

If your server runs cron per group, for example only bin/magento cron:run --group=default, add bin/magento cron:run --group=mst_echat as well, or the sync will not run.

You can also trigger a manual sync at any time using the CLI sync command.