Difference between revisions of "Mailchimp"

From WHMCS Documentation

(→‎Creating a MailChimp API Key)
(→‎Activating Mailchimp)
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
MailChimp integration is available in WHMCS 7.3 and later.
+
== About this Addon Module ==
  
−
==What is MailChimp?==
+
MailChimp is an email marketing and automation platform. It is free to use for up to 2,000 subscribers and allows up to 12,000 emails per month.
  
−
MailChimp is a powerful email marketing and automation platform that is free to use for up to 2,000 subscribers and allows up to 12,000 emails per month.
+
The WHMCS MailChimp integration uses MailChimp's ecommerce API to synchronize customer, order, and abandoned cart data with your MailChimp account. This allows you to use MailChimp to set up manual and automated campaigns.
  
−
The WHMCS MailChimp integration leverages MailChimp's e-commerce API to synchronize customer, order and abandoned cart data with your MailChimp account.  This allows you to take full advantage of MailChimp's advanced e-commerce automations to setup manual and automated campaigns including:
+
This includes:
  
−
* Thank you's to new customers
+
* Thank you messages to new customers.
−
* Automated follow-up's on abandoned carts
+
* Automated followup messages on abandoned carts.
−
* To provide on-boarding/drip-feed campaigns to new customers
+
* Onboarding or drip-feed campaigns to new customers.
−
* Attempt to win back lapsed customers who haven't bought anything recently
+
* Attempts to recapture lapsed customers who haven't bought anything recently.
−
* Reward your best customers based on order count or total spent
+
* Rewards for your best customers (based on order count or total spent).
  
−
Plus many more.
+
<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
 +
<tr>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
 +
</tr>
 +
<tr>
 +
<td style="border:1px #AAA solid;padding:0.2em;">Mailchimp</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 7.3 and later</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;color:darkgreen;">Yes</td>
 +
</tr>
 +
</table>
  
−
==Signup==
+
== Activating MailChimp ==
  
−
If you do not yet have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create one free here].
+
Because this addon ships with WHMCS by default, you only need to create a Mailchimp account and activate the addon through the Admin Area.
 +
 +
To do this:
  
−
==Initial Setup==
+
# If you do not yet have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create a free account here].
 +
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
 +
# Click '''Activate''' for '''MailChimp'''.
 +
# Click '''Configure'''.
 +
# Select the admin role groups who will have access to this addon.
 +
# Click '''Save Changes'''.
 +
# Log in to MailChimp.
 +
# Click the icon next to your name at the bottom left of the page.
 +
# Select '''Account & billing'''.
 +
# Select '''Extras > API keys'''. [[File:Mailchimp1.png|500px]]
 +
# Click '''Create A Key'''.
 +
# Copy the key to your clipboard. We also recommend giving the API key a label in your MailChimp account (''API Key for WHMCS'' in the example below).<br>[[File:Mailchimp2.png|500px]]
 +
# Go to '''Addons > MailChimp'''.
 +
# Enter the API key in WHMCS. You will see this screen the first time you access the MailChimp addon after activating it.<br>[[File:Mailchimp3.png|500px]]
 +
# Follow the instructions to finish the setup process.
  
−
# Navigate to Setup > Addon Modules
+
== Creating an Automated Campaign ==
−
# Locate the "MailChimp" module and click the '''Activate''' button.
 
−
# Assign your admin user role group (typically Full Administrator), access to the addon.
 
−
# Navigate to Addons > MailChimp to access
 
  
−
The first time you access the MailChimp addon you will be guided through a setup process that connects your WHMCS installation with your MailChimp account.
+
To create an automated campaign:
  
−
===Creating a MailChimp API Key===
+
# Log in to your [https://login.mailchimp.com/ MailChimp account].
 +
# Navigate to '''Create > Automations'''.
 +
# Click '''Get Started'''.
 +
# Click '''Check out Classic Automations'''.
 +
# Choose the '''E-Commerce''' options.<br>[[File:Mailchimp4.png|500px]]
 +
# Select your desired email from the list of premade options or click '''Custom''' to create a new campaign using advanced mode. For example, to create an onboarding automation for new customers, you would choose these options:
 +
## Select ''Follow up on purchases''. This option sends email after an applicable purchase according to your settings. <br/>[[File:Mailchimp5.png|500px]]
 +
## Select ''Product category''. This option only sends email for purchases of specific types of product. <br/>[[File:Mailchimp6.png|500px]]
 +
# Enter a name for your new automation (in this example, ''Follow up on SSL purchase'').
 +
# Choose the mailing list that you connected with your WHMCS installation. The campaign overview will display.
 +
# Click '''Edit''' next to the trigger to choose the applicable product category.<br/>[[File:Mailchimpedittrigger.png|500px]]  <br/>This example uses ''SSL Certificates'' as the product category.<br/> [[File:Mailchimp8.png|500px]]
 +
# Click '''Save'''.
 +
# Design your campaign's emails. You must create at least one.<br/> [[File:Mailchimp9.png|500px]]
  
−
You will be asked to provide a MailChimp API Key as part of this setup. If you do not yet have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create one free here].
+
== New Customers ==
  
−
1. Once logged in, to create a new API Key navigate to Account > Extras > API keys
+
New customers will be added to MailChimp with their opted in or out status determined depending on their marketing e-mails selection during account creation (either via the registration page or when placing their first order). Information on configuring marketing e-mail automation can be found at [[Marketing_Emails_Automation|Marketing Emails Automation]]
−
 
 
−
[[File:Mailchimp1.png]]
 
−
 
 
−
2. Click the Create A Key button. A new key will be automatically generated for you. Copy this key to your clipboard. We also recommend giving the API Key a label inside your Mailchimp account so you know what it is used for. Here we used the label "API Key for WHMCS".
 
−
 
 
−
[[File:Mailchimp2.png]]
 
−
 
 
−
3. Enter the API Key into WHMCS where requested. You will see this screen the first time you access the MailChimp addon after activating it.
 
−
 
 
−
[[File:Mailchimp3.png]]
 
−
 
 
−
==Creating your First Automation==
 
−
 
 
−
1. Login to your MailChimp account at https://login.mailchimp.com/<br>
 
−
2. Navigate to Campaigns > Create Campaign<br>
 
−
3. Choose Create an Email<br>
 
−
4. Select the Automated tab<br>
 
−
5. Choose the E-Commerce options. You will see a list like the one below.<br>
 
−
 
 
−
[[File:Mailchimp4.png]]
 
−
 
 
−
6. Now select your desired email from the list of pre-made options. Alternatively you can select the Custom button to create a new automation using the advanced mode.<br><br>
 
−
7. For the purposes of this demo, we are going to select the "Follow up on purchases" pre-made option which will allow us to create an on-boarding automation flow for new customers
 
−
 
 
−
[[File:Mailchimp5.png]]
 
−
 
 
−
8. You have a choice here of "Any product", "Specific product" or "Product category". We're going to select the Product category option.
 
−
 
 
−
[[File:Mailchimp6.png]]
 
−
 
 
−
9. Next enter a name for your new automation, we've chosen "Follow up on SSL purchase" and choose the mailing list you connected with your WHMCS installation earlier
 
−
<br><br>
 
−
10. The campaign overview will be displayed next. Select the Edit Trigger button to choose the product category that will trigger this email.
 
−
 
 
−
[[File:Mailchimp7.png]]
 
−
 
 
−
11. We are going to select "SSL Certificates" as the product category to trigger this email automation. This means any product purchase within the SSL Certificates product group will start the email campaign.
 
−
 
 
−
[[File:Mailchimp8.png]]
 
−
 
 
−
11. Hit save and now you can begin composing your campaign automation, starting with designing your first email, and adding others as you wish.
 
−
 
 
−
[[File:Mailchimp9.png]]
 
  
 
==Importing Existing Customers==
 
==Importing Existing Customers==
  
−
By default, the MailChimp WHMCS integration will only track customer signups and e-commerce transactions from the point is activated. To add your pre-existing customers to your MailChimp mailing list, you need to perform an import. Here's a quick guide for how to do it.
+
The MailChimp WHMCS integration will track customer signups and ecommerce transactions immediately upon activation. To add your preexisting customers to your MailChimp mailing list, you can perform an import.
−
 
 
−
1. Within your WHMCS installation navigate to Reports > Exports > Clients
 
−
 
 
−
2. Select the fields you wish to export.  We recommend First Name, Last Name, Company Name and Email Address
 
−
 
 
−
3. Click Filter to generate the list
 
−
 
 
−
4. Now select Tools > Export to CSV to download a CSV list of your customers
 
  
−
[[File:Mailchimp10.png]]
+
To do this:
  
−
5. Now within Mailchimp, navigate to Lists, choose the list you wish to import into
+
# Go to the WHMCS Admin Area and navigate to '''Reports > More'''.
 +
# Under '''Exports''', click '''Clients'''.
 +
# Select the fields to export. We recommend '''First Name''', '''Last Name''', '''Company Name''', and '''Email Address'''.
 +
# Click '''Filter''' to generate the report.
 +
# In the top-right corner, click '''Tools''' and choose '''Export to CSV'''. This allows you to download a list of your customers in the CSV format. <br/>[[File:clients-csv-8-2.png|500px]]
 +
# Go to MailChimp.
 +
# Navigate to '''Lists''' and choose the list you want to import customers to.
 +
# Navigate to '''Add contacts > Import contacts'''.
 +
# Choose the CSV or tab-delimited text file option.
 +
# Click '''Next'''.
 +
# Follow the displayed instructions to upload the CSV export and complete the import process.
  
−
6. Now navigate to Add contacts > Import contacts
+
== Troubleshooting ==
  
−
7. Choose the CSV or tab-delimited text file option and click Next
+
''N/A''
  
−
8. Follow the steps on screen to locate the CSV file export you just downloaded from WHMCS and complete the import process.
+
== Change Log ==
 +
''N/A''

Latest revision as of 19:56, 27 December 2022

About this Addon Module

MailChimp is an email marketing and automation platform. It is free to use for up to 2,000 subscribers and allows up to 12,000 emails per month.

The WHMCS MailChimp integration uses MailChimp's ecommerce API to synchronize customer, order, and abandoned cart data with your MailChimp account. This allows you to use MailChimp to set up manual and automated campaigns.

This includes:

  • Thank you messages to new customers.
  • Automated followup messages on abandoned carts.
  • Onboarding or drip-feed campaigns to new customers.
  • Attempts to recapture lapsed customers who haven't bought anything recently.
  • Rewards for your best customers (based on order count or total spent).
Addon Name Latest Release Current Version Compatible With Included in WHMCS
Mailchimp N/A N/A WHMCS 7.3 and later Yes

Activating MailChimp

Because this addon ships with WHMCS by default, you only need to create a Mailchimp account and activate the addon through the Admin Area.

To do this:

  1. If you do not yet have a MailChimp account, you can create a free account here.
  2. Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  3. Click Activate for MailChimp.
  4. Click Configure.
  5. Select the admin role groups who will have access to this addon.
  6. Click Save Changes.
  7. Log in to MailChimp.
  8. Click the icon next to your name at the bottom left of the page.
  9. Select Account & billing.
  10. Select Extras > API keys. Mailchimp1.png
  11. Click Create A Key.
  12. Copy the key to your clipboard. We also recommend giving the API key a label in your MailChimp account (API Key for WHMCS in the example below).
    Mailchimp2.png
  13. Go to Addons > MailChimp.
  14. Enter the API key in WHMCS. You will see this screen the first time you access the MailChimp addon after activating it.
    Mailchimp3.png
  15. Follow the instructions to finish the setup process.

Creating an Automated Campaign

To create an automated campaign:

  1. Log in to your MailChimp account.
  2. Navigate to Create > Automations.
  3. Click Get Started.
  4. Click Check out Classic Automations.
  5. Choose the E-Commerce options.
    Mailchimp4.png
  6. Select your desired email from the list of premade options or click Custom to create a new campaign using advanced mode. For example, to create an onboarding automation for new customers, you would choose these options:
    1. Select Follow up on purchases. This option sends email after an applicable purchase according to your settings.
      Mailchimp5.png
    2. Select Product category. This option only sends email for purchases of specific types of product.
      Mailchimp6.png
  7. Enter a name for your new automation (in this example, Follow up on SSL purchase).
  8. Choose the mailing list that you connected with your WHMCS installation. The campaign overview will display.
  9. Click Edit next to the trigger to choose the applicable product category.
    Mailchimpedittrigger.png
    This example uses SSL Certificates as the product category.
    Mailchimp8.png
  10. Click Save.
  11. Design your campaign's emails. You must create at least one.
    Mailchimp9.png

New Customers

New customers will be added to MailChimp with their opted in or out status determined depending on their marketing e-mails selection during account creation (either via the registration page or when placing their first order). Information on configuring marketing e-mail automation can be found at Marketing Emails Automation

Importing Existing Customers

The MailChimp WHMCS integration will track customer signups and ecommerce transactions immediately upon activation. To add your preexisting customers to your MailChimp mailing list, you can perform an import.

To do this:

  1. Go to the WHMCS Admin Area and navigate to Reports > More.
  2. Under Exports, click Clients.
  3. Select the fields to export. We recommend First Name, Last Name, Company Name, and Email Address.
  4. Click Filter to generate the report.
  5. In the top-right corner, click Tools and choose Export to CSV. This allows you to download a list of your customers in the CSV format.
    Clients-csv-8-2.png
  6. Go to MailChimp.
  7. Navigate to Lists and choose the list you want to import customers to.
  8. Navigate to Add contacts > Import contacts.
  9. Choose the CSV or tab-delimited text file option.
  10. Click Next.
  11. Follow the displayed instructions to upload the CSV export and complete the import process.

Troubleshooting

N/A

Change Log

N/A

Retrieved from "http://3.17.75.209/index.php?title=Mailchimp&oldid=33769"