Magento 2.x Integration

Note

To get started, you must have an account created with Talkable, and a Magento Marketplace account. If you do not have a Magento Marketplace account configured, follow these steps to connect one to your Magento store.

The Magento 2 Integration Extension is available to download in the Magento Marketplace. The extension supports all versions of Magento 2.0 or higher.

Installation

  1. Visit the Magento Marketplace and get the Talkable extension.

    ../../_images/install0.jpg
  2. Navigate to SystemWeb Setup Wizard in your Magento store admin panel.

    ../../_images/install1.jpg
  3. Choose Extension Manager.

    ../../_images/install2.jpg
  4. The Extension Manager will indicate that you have extensions ready to be installed. Click the Review and Install button.

    ../../_images/install3.jpg
  5. Click the Install button at the top of the list to install all listed extensions. To just install Talkable, find the extension in the list and click Install.

    ../../_images/install4.jpg
  6. Follow the steps to complete the Talkable extension installation.

    ../../_images/install5.jpg

Warning

Take note of the Magento 2.x system requirements regarding extension installation. Magento recommends that you have 2GB of RAM allocated to PHP for upgrading and installing extensions from the Marketplace.

Refer to Troubleshooting section of this guide if you encounter problems during this step.

Activating the Integration

  1. After successful installation, navigate to SystemIntegrations page of your admin panel.

    ../../_images/activate1.jpg
  2. Find “Talkable” in the list of integrations and click the Activate link.

    ../../_images/activate2.jpg
  3. Review the list of permissions that the Talkable extension needs and click Allow.

    ../../_images/activate3.jpg
  4. Log in to your Talkable account (if you’re already logged in, this step will be omitted).

    ../../_images/activate4.jpg

  1. All done! You have successfully integrated Talkable. To verify your Talkable integration, please visit Integration tab in Site Settings.

    ../../_images/activate5.jpg

Note

Activating the integration allows Talkable to configure your extension automatically. If you choose not to activate the integration, you will need to specify your Talkable Site ID in the Integration section of extension settings.

Accessing Talkable Configuration

  1. To access Talkable extension settings, navigate to StoresConfiguration in your Magento admin panel.

    ../../_images/access1.jpg
  2. Then select TalkableTalkable Configuration from the list of available configurations. If you have multiple stores, select the desired Store View you want to change the settings for.

    ../../_images/access2.jpg

Configuring Talkable Extension

The extension configuration screen consists of three sections: Integration, Campaigns and Page URLs.

../../_images/configure1.jpg

Integration

The Integration section allows you to change the Talkable Site ID, which is used to connect your store to your Talkable account.

../../_images/configure2.jpg

Warning

Only change this setting if you need to connect your store to a different site in the Talkable dashboard. An incorrect value will prevent your campaigns from showing.

Changing the Site ID will invalidate the full page cache. Magento will display a warning message with a link to the Cache Management page. Please follow this link and refresh the invalidated cache types.

../../_images/cache.jpg

Note

If you have activated the extension’s integration, the Site ID will be prefilled (see Activating the Integration). If you chose not to activate the integration, you need to paste the Site ID from your Talkable Site Dashboard into this field.

../../_images/configure3.jpg

Campaigns

The Campaigns section allows you to enable or disable different types of campaigns on your site. For example, if you don’t have Standalone or Advocate Dashboard campaigns configured in Talkable, you can disable these campaigns in extension config, so the corresponding pages are not accessible.

../../_images/configure4.jpg

Page URLs

The Page URLs section allows you to change paths to the Standalone Share and Advocate Dashboard pages. The paths must match the placements you have configured in Talkable for this campaign type. Default values correspond to default placements in Talkable.

../../_images/configure5.jpg

Warning

Only change these settings if you have configured custom placements for these campaign types in your Talkable dashboard. Incorrect values will prevent your Standalone or Dashboard campaign from showing.

../../_images/configure6.jpg

Troubleshooting

This section describes the solutions to some common issues encountered during installation that do not provide helpful error messages or a clear path forward. If you encounter an issue that isn’t described here, please refer to the Magento troubleshooting suggestions for the Component Manager and other Magento documentation.

 

  • Check Component Dependency step fails without an error message

    ../../_images/troubleshooting1.jpg

    The Check Component Dependency script has likely run out of memory. Magento 2.x requires at least 756MB of RAM allocated to PHP. However, to use Web Setup Wizard for system upgrades and extension installation, Magento recommends allocating 2GB of memory to PHP. Please refer to the Required PHP Settings guide and update your configuration.

     

  • Create Backup step fails without error message

    ../../_images/troubleshooting2.jpg

    Backup creation in Component Manager is performed as a single web request. This request can take a long time, especially if you have chosen all three backup options (Code, Media, and Database). If the backup request takes longer to complete than allowed by your server configuration, the server will terminate the request, resulting in backup failure.

    Possible solutions:

    1. Choose to only back up Code at the Create Backup step. If you have your own backup procedure set up, we recommend performing it prior to installing the extension.

      ../../_images/troubleshooting3.jpg
    2. Configure your server to allow long-running requests.

    • In PHP configuration, increase max_execution_time to 300-600 seconds. This can be done either in your php.ini file or in the .htaccess file in your Magento root folder.

    • For Apache 2, increase TimeOut to 300-600 seconds in your server configuration.

    • For nginx + php-fpm, set the following directives in your server configuration:

      client_header_timeout 300s;
      client_body_timeout 300s;
      fastcgi_read_timeout 300s;
      

      Warning

      Increased request timeout settings can negatively affect server performance.