Zephr User Guide


0 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 Extensions, 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 Extension

To enable the Mailchimp Extension within Zephr, navigate to Settings > Extensions > Mailchimp. If you cannot see the Mailchimp option in your list of Extensions, email support@zephr.com.

Once on the configuration screen, you’ll see two sections – Mailchimp API Details and Activate Plugin.

Mailchimp API Details

First, click Mailchimp API Details. Here, you’ll need to input the following information:

  • 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 Set Up

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, along with the Zephr Registration Date and Tracking ID to fields of a similar name within Mailchimp. You can learn how to set Default Merge Values for Mailchimp here.

  "tracking_id": "trackingId",
  "registered": "registerDate",
  "attributes": {
    "first-name": "firstName",
    "last-name": "lastName"

Once completed, click Done.

Activate Plugin

Once you’ve input your API details, confirm which of your Sites the extension should be active on. To do this, use the toggles for each site under the Activate Plugin section, or choose Select All Sites.

Mailchimp - Plugin Activation

Once completed, click Save. Your extension is now enabled and will be in use for all new Zephr registrations.