Skip to main content




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 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.

Audience Configurations

The Audience Configurations input takes a JSON array where the members are JSON objects representing configuration values for each of the Audiences (Lists) you wish to add users to. The objects in the Audience Configurations array have a format like so:

    "userAttribute" : "<zephr_control_attribute>",
    "audienceId" : "<mailchimp_audience_id>",
    "addIfValueIs" : <true|false>

The value for the “userAttribute” key should be the slug of a Zephr user attribute, nominated to record whether a user has granted consent to be added to the relevant list. The type of this attribute must be ‘checkbox’ when created in the User Attributes section of the Admin Console. An attributes slug will be a lower case, hyphenated version of the attribute name. For example, Newsletter Opt In will have the slug newsletter-opt-in.

The value for the “audienceId” key should be the ID for the relevant MailChimp Audience.

The value for the “addIfValueIs” key should be a boolean. This dictates whether a ‘true ’or ‘false’ value recorded against the nominated User Attribute in Zephr should result in the user being added to the relevant Audience. Typically you will use a value of ‘True’ if you have an ‘opt-in’ user attribute and ‘False’ if you have an ‘opt-out’-style attribute.

Please see below for an example of a multi-list setup, including both ‘opt-in’ and ‘opt-out’ style configurations:

        // in this example, user is added to list in MailChimp if value of
        // nominated user attribute is 'true' - i.e .opt-in style consent
        "userAttribute" : "newsletter-opt-in",
        "audienceId" : "12345",
        "addIfValueIs" : true
        "userAttribute" : "offers-opt-in",
        "audienceId" : "678910",
        "addIfValueIs" : true
        // in this example, user is added to list in MailChimp if value of
        // nominated user attribute is 'false' - i.e .opt-out style consent
        "userAttribute" : "related-company-contact-opt-out",
        "audienceId" : "1112131415",
        "addIfValueIs" : false

MailChimp to Zephr Attribute Mapping

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.

Note: the closest approximation to a Zephr User Attribute in MailChimp is a ‘Merge Tag’, you can find a full list of MailChimp Merge Tags here.

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


Please Note: In most use cases, there is no need to add any mapping configuration for the user’s email address – if the user has consented to be added to an Audience, their email address will automatically get synced to MailChimp.

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.