Please Note: The Dixa-Magento integration is currently in beta.

With our Magento v1 integration you can display customer information from your Magento store in the conversation view.

Order information can be searched by entering the customer’s phone number or email address depending on the contact channel.

In Magento

This will guide you through the installation of the Dixa SearchAPI Magento extension. Considering that this extension is currently still under development, it is not available through Magento Connect.


On Linux or macOS, open a terminal session and upload the extension package to your server.

scp Dixa_SearchAPI-0.3.0.tgz username@server:

Then, login to the server:

ssh username@server

Next, you're going to need to do a few things:

  • Create a temporary directory to work in
  • Move the extension package into that directory, and change directory into it
  • Extract the contents of the extension package
mkdir tmp-dixa
mv Dixa_SearchAPI-0.3.0.tgz tmp-dixa
cd tmp-dixa
tar xvf Dixa_SearchAPI-0.3.0.tgz

This will create a directory called 'app' and a file package.xml.

Now, we need to install the extension into your Magento installation. This guide will assume that your Magento instance is installed in /var/www/html/magento:

cp -a app/* /var/www/html/magento/app

Note: If you have previously installed an older version of the Dixa SearchAPI, remember to remove it before installing the new extension:

rm -rf /var/www/html/magento/app/code/community/Dixa/SearchAPI


Now that the plugin is installed, we need to establish communication between Dixa and the extension. This is done by generating a small token that ensures the safety of your data.

Log in to your Magento Admin Interface, and navigate to the system and then configuration page:

If the extension was correctly installed, you will notice a new menu entry on the left hand side:

After clicking on this menu entry, you will be presented with the following screen:

Simply click on "Generate", followed by "Copy to Clipboard". This will copy your new API key to your system's clipboard. This API key has to be sent to Dixa staff so that we can setup the integration.

Don't forget to save the configuration using the button in the top right corner. If everything went correctly, your configuration should look something like this:

In Dixa

  1. Go to Settings.
  2. Go to Integrations.
  3. Click in Configure Integration under the Magento V1 icon.
  4. Click Add Magento Card.
  5. Enter a title for the card (ie. Order History).
  6. Insert the API Key from your Magento account.
  7. Insert your Magento Subdomain URL.
  8. Click Save.

Example of orders in Magento

When no orders are found in Magento