Email Service Integration - MailChimp - Subscription tagging¶
Target Audience: Developers, Stakeholders
Creating your MailChimp account¶
In order to get started with your first subscription tagging through MailChimp, a MailChimp account naturally has to be created. You can create a free MailChimp account here.
Fetching your API key¶
In order for Payway to be able to notify MailChimp about updated subscription tags, an API Key is required.
In order to obtain your MailChimp API key, navigate to Profile => Extras => API keys => Create A Key and follow the on-screen instructions. Be sure to save your generated API key somewhere safe, as you will need it later.
Configuring your sending domain¶
Having the MailChimp account created and the API key fetched, we can now move on to configuring your sending domain. This is a process that validates that you, in fact, own the domain that you say you do, and allow email's to be sent from that given domain.
In order to configure your sending domain, perform the following steps:
- From within MailChimp, navigate to Profile => Domains => Add & Verify Domain.
- Enter an email address belonging to the domain you wish to send your email from.
- Follow the on-screen guide provided by MailChimp to verify your domain. This will require changes to your DNS records.
Configuring your audience¶
In order to start syncing your customers subscription tags between Payway and MailChimp, we must know what the relation between Payway and MailChimp looks like.
In order to configure this relation, perform the following steps:
- From within MailChimp, navigate to Audience => All contacts. If you have multiple audiences, make sure you select the correct one!
- Select Settings => Audience name and defaults, and take note of the Audience ID. Save this ID somewhere safe, as you will need it shortly.
- From within the Payway Administration Portal, navigate to Control panel => Tags => Create tag.
The name of the tag should correspond according to the following format:
mc:<ACTION>:<TAG_NAME>:<AUDIENCE_ID>
For example, if you would like to add the "digital" tag to the customer when a subscription is created, it would look something like this:
mc:add:digital:abc123
| Key | Description |
|---|---|
| ACTION | Which action that should be taken in MailChimp when this tag is sent. Set to add to add the Tag to the customer. Set to rm to remove the tag from the customer. |
| TAG_NAME | The name of the tag that should be applied to the customer. |
| AUDIENCE_ID | The Audience ID fetched from MailChimp in the previous step |
The tags and their respective actions have different behaviour, depending on which event is triggered from Payway. While the behaviour is based off of new subscriptions or subscription renewals, we recommend you have a look at the table below to better understand what this means in practical terms.
| Event | Behaviour |
|---|---|
| Order closed | Standard behaviour. Tags set to add will be added, tags set to rm will be removed. |
| User product renewed | Standard behaviour. Tags set to add will be added, tags set to rm will be removed. |
| User product deactivated | Inverted behaviour. Tags set to rm will be added, tags set to add will be removed. |
Once you have created the tag as you like it, simply apply the tag to one or more packages of your choosing.
Creating your first tag¶
Once you have gotten this far, you're almost through the finishing line!
Now, all that remains, is to simply contact our support. Information that must be included in this request are:
- Your Mailchimp API Key
- Your sender email address (the email address that your email's should originate from)
Once your support request has been sent and we have had time to process it, you can start sending your first emails from MailChimp!