Technical Documentation


16 views 0

Mailchimp is a popular marketing automation platform and email marketing service. As part of our range of out-of-the-box integrations, Zephr offers a Mailchimp Plugin, ensuring Users who register within Zephr are added as Contacts within Mailchimp. The integration can also trigger automated emails from Mailchimp custom events within Zephr rules.

This integration will add Contacts to Mailchimp conditionally – during configuration, you will nominate a user attribute that denotes explicit consent from the user to determine if a user is added to Mailchimp. The plugin allows you to set the List (Mailchimp Audience) to which you wish those Users to be added. A mapping file lets you choose which information to share with Mailchimp.

Configuring the Mailchimp Plugin

To enable the Mailchimp plugin within Zephr, navigate to Settings > Plugins > Mailchimp. If you cannot see the Mailchimp option in your list of Plugins, email

Once on the configuration screen for the Plugin, you will need to enter the following details:

  • API Key
  • Mailchimp Data Center
  • Mailchimp List ID – note this is the ID of the Mailchimp List you wish your Users to be added to
  • Mailchimp Event

These details will need to come from your existing Mailchimp account. If you do not know these details, please consult the Mailchimp help guide, or get in touch with your Mailchimp Account Manager.

Next, you will need to specify which user attribute holds the value recording whether a user has granted explicit consent for email communications (usually an ‘opt-in’ or ‘opt-out’ field). The type of this attribute must be ‘checkbox’. Take a look at our User Schema guide for information on how to add a new field, if required.

Once you have nominated the user attribute that holds the consent value, you will need to specify whether a value of ‘True’ (checked) or ‘False’ (unchecked) should mean a user’s details are exported to MailChimp. Typically you will need to use a value of ‘True’ if you have an ‘opt-in’ user attribute and ‘False’ if you have an ‘opt-out’-style attribute.

Mailchimp - Opt In

Following this, add a JSON mapping under the Mailchimp Objects section. This mapping allows you to map your Zephr User Schema Attributes to the Attributes stored against a Contact within Mailchimp. For example, the following mapping would be used to map User Schema Attributes of First Name and Last Name to fields of a similar name within Mailchimp. You can learn how to set Default Merge Values for Mailchimp here.

"FNAME": "firstname",
"LNAME": "last-name"

Once completed, click Activate. Your plugin will now show as Enabled and will be in use for all new Zephr registrations.

Triggering Automated Marketing within a Zephr Rule

As part of our integration with Mailchimp, we’ve created a way for you to trigger automated marketing,

sent via Mailchimp, from within a Zephr Rule. This feature uses Mailchimp to trigger automated emails and adds a new Mailchimp option for you to drag and drop into the Zephr Canvas when creating a Rule.

In order for Mailchimp to listen for Zephr triggers, you will first need to create a custom event in Mailchimp,  the event name, and the action to be done. Details on how to do this can be found in the Mailchimp documentation.

Once set up, navigate to the Zephr rule where you would like to trigger the automated email from. On the left-hand panel, you will see a drag and drop option for Mailchimp, drag this into your Rule Canvas and choose your Event from the dropdown menu. Connect this node into your rule at the point you would like the email triggered.

Mailchimp Event Trigger in Feature Rule

Once you’re happy with your rule, click Save. Remember you will need to Publish your rule in order for it to go live on your site.