MageMonkey‎ > ‎


Does MageMonkey works with MagentoGO?

No, it doesn't.

Where I have to set up the WebHook url?

The WebHook URL should be automatically generated every time you save your settings and should not be edited in MailChimp.
You can check your WebHook URL in:
MailChimp Account / Lists / <your_list> / Settings / WebHooks.

Working with multiple environments?

If you're planning to test MageMonkey in your development environment, please consider use different MailChimp Lists: One list for each environment.

MageMonkey saves in each List a WebHook URL referencing to your Store.
So, if you use the same List, your List will have multiple WebHooks configured and MailChimp will push changes to all.

In any case, if you remove all of your WebHooks from your MailChimp List, go to MageMonkey configuration, and saves it's configuration, MageMonkey will check if your List has any WebHook configured. If it hasn't, MageMonkey will add it.

How to implement interest groups in my list?

You just have to create your interest groups in MailChimp and the extension will automatically list groups below list name.
In order to create a new interest group you have to loggin into your MailChimp account go to your list choose "Groups" tab and click on "Create Groups".

Identify each transactional email template and pages

In order to change your Transactional Emails in Magento, you need to go to:
System / Transactional Emails

If you need to change MailChimp templates, you need to go to:
MailChimp Account / Lists / <select_your_list> / Signup Forms / General Forms

Welcome email

Type: Email
Template: Magento Transactional Email Template

Confirm your subscription

Type: Email
Template: MailChimp Template
(this happens when you use double opt-in, check MageMonkey Configuration section)

Subscription Confirmed

User is redirected to MailChimp confirmation page
Type: Page
Template: MailChimp Template
(this happens when you use double opt-in, check MageMonkey Configuration section)

Final Notification

Type: Email
Template: MailChimp Template

How to implement Signup Embed Form?

In order to implement the MailChimp sign up embed forms follow this simple steps:

1) Search for the list you want the users be subscribed:



2) Select from the settings menu the option For Your Website -> Signup Form Embed Code

3) In this page you can customize your form adding fields and editing some display settings:

4) Copy the generated code below the form preview and check that the fields have the correct names. The names of the fields in the form has to be the sames as in the Settings -> List Fields and *|MERGE|* Tags section and in your Magento under System -> Configuration -> MageMonkey you have to got the same merge fields so at the moment the user fill the form we can match this fields with the given ones.
Check here to see how to configure the fields Mapping.

After this you can add css styles and finish to customize your form. And finally paste this code in the place you want.

How Can I sync subscribers in Magento with MailChimp?

If you just installed our extension and you already have subscribers in Magento and want to send to MailChimp you can make an export.
In order to do this in the admin panel you have to go to Newsletter -> MailChimp -> Bulk Sync -> Export.
In the dropdown "Data Source" you have two options:

1) Subscribe Magento customers to MailChimp (send ALL the customers you have in Magento)
2) Send Magento Newsletter subscribers to MailChimp (send just the customers subscribed to the newsletter)

The export process run every one hour, but if you are hurry you can install this extension and will be able to run it instantaneously.

Important: You dont need to run the export everytime, the export it's just for the first time you install the extension or for export the list to a new list or a particular situation.
Every new subscriber in your site will be send to MilChimp automatically

How Can I sync subscribers in MailChimp with Magento?

If you just installed our extension and you already have subscribers in MailChimp and want to bring them to Magento you can make an import.
In order to do this in the admin panel you have to go to Newsletter -> MailChimp -> Bulk Sync -> Import.
In this section you will see a few options:

1) Choose Lists (This are your MailChimp lists, you have to select the list/s your subscribers are)
2) Statuses to import (Maybe you just want to bring just the users subscribed to your list or maybe the Unsubscribed, Cleaned and Updated too)
3) Create customer accounts (we give you the option to create a new account for those users that are not already in Magento)
4) Retrieve data since (You can define the date that your subscribers were added to MailChimp)

The import process run every one hour, but if you are hurry you can install this extension and will be able to run it instantaneously.

Important: You dont need to run the import everytime, the import it's just for the first time you install the extension or a particular situation.
Every new subscriber in MailChimp will be send to Magento automatically

How long does Import/Export Sync take?

It depend on how you have configured your Magento cron process, if you don't know please contact your server support.
By default we run the process (import/export) every one hour, you can change this values editing the file app/code/community/Ebizmarts/MageMonkey/etc/config.xml
There is a particular line for the import and another for the export, they looks like this:

<schedule><cron_expr>0 * * * *</cron_expr></schedule>

If you want to edit please be sure that the value it's correct, for more information about cron please visit this link

In the most part of the cases in which the status of the Import or Export process keep always as IDLE it's because the cron it's not configured properly

How can I export old orders to MailChimp

To do this you need to go to Sales -> Orders, select the orders you want to send.
Finally select action "Send to MailChimp" and Submit.

How I set up the Magento cron?

In order for the Bulk Sync jobs, export and import, process the data, its necessary to have Magentos cron running first.

You can do this easily if you have shell access to the server by enabling a crontask, for example

crontab -e

then when the cronjobs list appear add Magentos cron to run every 5 minutes

*/5 * * * * /bin/sh /absolute/path/to/magento/

please change /absolute/path/to/magento/ to your .sh file absolute path. There is a great extension on Magento Connect, its called AOE Scheduler that allows you to visualize all cron tasks and current status, errors, schedule, etc. MageMonkey's bulk jobs will run every hour and job codes are as follows.

Export: magemonkey_bulksync_export_subscribers
Import: magemonkey_bulksync_import_subscribers

Note: Ensure that your file has execution permission.
You can give that permission by running: chmod +x

Where i can find a downloadable version of your extension?

For those users that use Magento Enteprise or just don't want to use Magento Connect to install our extension you need to follow the instructions as explained on Manual installation.

I don't receive the Welcome Email

If you're using Single opt in, this email won't be sent.
You could enable Double opt-in as explained in Understanding the Double-opt in.
Or you could just enable welcome email following this steps: Using Simple-opt in and I want welcome email-

Associate more info to my Customer subscriptions using FieldMapping

This HOWTO will assume -and require- that you've a certain knowledge about PHP programming.

Remember to backup your files and try this in a local/dev environment first.

There're three main steps to add a new value into your subscriptions.
  1. Add new field into your List.
  2. Update your Field Mapping configuration.
  3. Modify your MageMonkey and retrieve your value.

Add new field into your List

You need to go to your MailChimp List and add your new field.
After that, go to "Settings / List fields and *|MERGE|* tags", and assign to your new field a MERGE tag (we will use this merge tag value in step 2).

Update your Field Mapping configuration

Now, you need to add your value in the Field Mapping, so MageMonkey knows that this value needs to be added (view configuration section).
In Magento column you need to put a unique lowercase name for this new value (with no special characters or spaces).
In MailChimp column, you need to put the exact same MERGE tag that you assigned to your field List.

Modify your MageMonkey and retrieve your value

Last part, is to actually retrieve your value and insert it into the mergevars of MageMonkey.

File: Ebizmarts/MageMonkey/Helper/Data.php
Function: mergeVars()

Within this function, you'll find a big SWITCH, where all Field Mappings are evaluated.
What you need to do, is to add a new "case" with the name that you used in FieldMapping / Magento column.

case 'your_fieldmapping_magentocolumn_value':
        // put in here all your code to retrieve your value.
        // and later assign it to $merge_vars[$key]
        $yourVariable = 'This data will be pushed.';
        $merge_vars[$key] = $yourVariable;

As you can see, we're not explicitly specifying the "MageMonkey/FieldMapping/MailChimp column" value that we configured earlier. That's because it's being assigned in the $merge_vars array, by the $key variable. 
Within this "case" that you're adding, do your stuffs to retrieve your desired value and finally assign it to $merge_vars[$key].

Here's an example:
Let's imagine that we want to add the City of the Customer.

Step 1.
In your MailChimp List, you've a new textfield. And you've assigned "CITY" as the MERGE tag.

Step 2.
In MageMonkey / FieldMapping / Magento column: city
In MageMonkey / FieldMapping / MailChimp column: CITY

Step 3.
So we'll add this code into the SWITCH:

case 'city':

// all the code to retrieve the city into the variable $myCity
        $myCity = 'My City Name';
        $merge_vars[$key] = $myCity;


And that's it!
Remember that if you update your MageMonkey module, this changes could be lost. So backup your files before/after doing this change.

How to view pushed orders to MailChimp when using Ecommerce360

If you have "Use Async subscribe in checkout" enabled the order might still be in your database waiting for the cron process to run to get send.
You can see all waiting orders in your database table named "magemonkey_async_orders" with processed = 0.

To see the already sent orders you can go to your MageMonkey log file located in: <website_root>/var/log/MageMonkey_ApiCall.log (If enabled on Magento's MailChimp configuration)
Within this file, and search for:
    [0] => ecommOrderAdd

Each occurrence for that API method, will be followed with the Order's data that has been pushed to your MailChimp Account.

Here's an example:
    [0] => Array
            [id] => 100000001
            [total] => 14.2000
            [shipping] => 4.2000
            [tax] => 3.5000
            [store_id] => 1
            [store_name] => Main Website
Main Website Store
Default Store View
            [plugin_id] => xxxx
            [items] => Array
                    [0] => Array
                            [product_id] => 1
                            [sku] => XXXXX
                            [product_name] => My Sample Product Name
                            [category_id] => 3
                            [category_name] => Default Category - First Category
                            [qty] => 1.0000
                            [cost] => 14.2000


            [email] =>

    [__pid] => xxxxx

How to send campaigns depending on purchased product attribute?

Please note for this to work you need to enable Ecommerce360 and set at least one attribute to get sent to MailChimp.

First you need to login at and access to Campaigns on the menu.
Then click Create Campaign button, select the campaign type and the list you wish to send it.

Create Campaign

Some options will be displayed and you should select Send to new segment.
Finally select to filter by Product Purchased that contains the attribute you wish (e.g. sku: hde003) and click refresh count to see how many subscribers made that purchase and will receive this campaign.

You can add as many segments as you wish.