CiviCRM & Mailchimp

24 April 2014

VEDA NFP Consulting are pleased to announce the release of the Mailchimp Integration extension. The new extension builds on the existing work done by the science gallery, adding the ability to pick the Mailchimp List the CiviCRM group should be integrated to as well as making the entire process a much simpler one to setup.

VEDA NFP Consulting are pleased to announce the release of the Mailchimp Integration extension. The new extension builds on the existing work done by the science gallery, adding the ability to pick the Mailchimp List the CiviCRM group should be integrated to aswell as making the entire process a much simpler one to setup.

The instructions below will walk you through getting the extension installed and configured.

Step 1 - Install the CiviCRM Mailchimp Extension

1. Download extension from https://github.com/veda-consulting/uk.co.vedaconsulting.mailchimp/releases/latest.
2. Unzip / untar the package and place it in your configured extensions directory.
3. When you reload the Manage Extensions page the new "Mailchimp" extension should be listed with an Install link.
4. Proceed with install.

Step 2 - Get your Mailchimp API

CiviCRM will connect to your Mailchimp Account using Mailchimps API

To get your accounts API you should follow these instructions

Mailchimp API

Step 3 - Add your API key to CiviCRM

Once you've setup your Mailchimp API key it can be added to CiviCRM

When the CiviCRM Mailchimp Extension was installed, an additional menu option would have been added to allow you to set the API

Click on the "Mailchimp Settings" option and enter your mailchimp API key that you got in step 2 above, into the settings field. You can see an example below.

Pressing "Save & Test" will test that a connection can be made to your Mailchimp account.

Step 4 - Setup the Groups

The CiviCRM Mailchimp extension will also add extra mailchimp settings to the CiviCRM Group Settings.

If you navigate to the settings of the group you wish to sync with Mailchimp you should be presented with these extra fields, as displayed in the screenshot below

Selecting the Mailchimp List you wish to sycnronise to will then also allow you to pick a particular Mailchimp Segment. This is optional, you could leave the synchronisation to push the group to the list without picking a segment.

Step 5 - Test out the Sync

The CiviCRM Mailchimp extension will also add extra mailchimp settings to the CiviCRM Group Settings. Click on the "Mailchimp Sync" under the mailing menu.

Once you press the "Sync Contacts" button you should then see the email addresses being pushed over to Mailchimp. Once complete a summary will be displayed.

If you see the above then thats the main setup complete and if you login to your Mailchimp account you should see the email addresses from CiviCRM in the list that you've setup.

Just one or two more settings and we're done!

Step 6 - Setup the Scheduled Job

Mailchimp to CiviCRM and CiviCRM to Mailchimp sync process can be automated and run on regular basis using the "Mailchimp Sync" scheduled job shipped by extension. The job can be enabled and configured from the Scheduled Job screen: Administer > System Settings > Scheduled Jobs.

Step 7 - Setup Mailchimp Web Hooks

The CiviCRM Mailchimp extension will allow you to confirgure Mailchimp to update CiviCRM with changes to subscriber information, for example if the subscriber provides a new email address or unsubscribes from the list/segment.

To do this you need to configure Mailchimp Webhook settings with the relevant CiviCRM Url.

Here are the basic steps:

  1. To know the relevant CiviCRM url visit https://<<your_site>>/civicrm/mailchimp/settings?reset=1.
  2. In the "Security Key" field entering a key would show the complete webhook url. Note down the complete url.
  3. Make sure webhook url is accessible to public. If not, just make sure anonymous / public user has "allow webhook posts" permission.
  4. Log in to your MailChimp account.
  5. Navigate to your Lists.
  6. Click Webhooks under Settings menu and Click 'Add a New Webhook' button.
  7. Enter the CiviCRM Webhook URL, noted in #2 ( https://<<your_site>>/civicrm/mailchimp/webhook?reset=1&key=ABCD ) in Callback URL field.
  8. Tick the relevant options for type of updates and when to send an update.
  9. Click Save.

You need to repeat the above steps for all Mailchimp lists from which you need to send updates to CiviCRM.

Keep in touch, we value relations!

Connect with us