For the complete documentation index, see llms.txt. This page is also available as Markdown.

Popin Video Call Widget for Magento 2

Integrate Popin live video shopping into your Magento 2 store. This module adds the Popin video call widget to your storefront, enabling real-time video conversations between customers and sales representatives.

When a logged-in customer initiates a video call, their profile information (name, email, phone, postal code) is automatically passed to the Popin widget so your agents have context before the conversation begins.


Requirements


Installation

Download the module from this repository:

git clone https://github.com/Springr-Creatives/Popin-Magento.git

Copy the module into your Magento installation:

cp -r Popin-Magento/app/code/Popin <your-magento-root>/app/code/Popin

Enable the module and run setup:

cd <your-magento-root>
bin/magento module:enable Popin_Widget
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

Option B: Composer Installation

Add the repository to your Magento project's composer.json:

Require the package:

Enable the module and run setup:


Configuration

In the Magento Admin, navigate to:

Stores > Configuration > Popin > Video Call Widget

Configure the following settings:

Setting
Description

Enable Popin Widget

Set to Yes to activate the widget on your storefront.

Popin Token

Enter the token from your Popin dashboard. Required for the widget to function.

Widget Mode

Hidden — widget is triggered via a button click. Visible — widget launcher appears automatically on page load.

Click Save Config and flush the cache:

All three settings can be configured per Store View, Website, or Default scope, allowing different configurations for different storefronts.


How It Works

Once enabled, the module injects the Popin widget script on every frontend page (before </body>). The widget connects to Popin's servers using your token and initializes in the selected mode.

Customer data capture

For logged-in customers, the module automatically collects and passes the following information to the Popin widget:

  • Name — from the customer profile

  • Email — from the customer profile

  • Phone — from the default billing address

  • Postal code — from the default billing address

Guest visitors can still use the widget; they simply won't have pre-filled information.


Adding a Custom Button (Hidden Mode)

When the widget mode is set to Hidden, the Popin launcher does not appear automatically. You need to add a button to your template that opens the widget on click.

Use the popin.Popin('open') JavaScript call to trigger the widget.

Basic example

Styled example


Where to Place the Button

In Magento 2, you can add the button in any of these ways:

  • CMS Block / Page Go to Content > Blocks (or Pages) in the Admin and add the button HTML directly in the content editor (use the HTML/source mode).

  • PHTML Template Add the button to a template file in your theme. For example:

  • Layout XML Add a CMS block reference via layout XML to inject the button into a specific container on certain pages.

Note: The button will only work on pages where the Popin widget script is loaded. Since this module injects the script on all frontend pages, the button can be placed anywhere on your storefront.


Updating

If installed manually

Download the latest version:

Replace the module files in your Magento installation:

Run setup:


If installed via Composer

Note: If you previously had to whitelist *.popin.to in Magento's Content Security Policy manually, this update makes that unnecessary. The module now handles CSP configuration automatically. You can remove any manual CSP entries you added for Popin.


Uninstallation

If installed manually


If installed via Composer

Last updated