Difference between revisions of "Mailchimp"
From WHMCS Documentation
m |
|||
| Line 1: | Line 1: | ||
MailChimp integration is available in WHMCS 7.3 and later. | MailChimp integration is available in WHMCS 7.3 and later. | ||
| − | ==What is MailChimp?== | + | == 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 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 | + | 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 | + | This includes: |
* Thank you messages to new customers. | * Thank you messages to new customers. | ||
| − | * Automated | + | * Automated followup messages on abandoned carts. |
* Onboarding or drip-feed campaigns to new customers. | * Onboarding or drip-feed campaigns to new customers. | ||
* Attempts to recapture lapsed customers who haven't bought anything recently. | * Attempts to recapture lapsed customers who haven't bought anything recently. | ||
* Rewards for your best customers (based on order count or total spent). | * Rewards for your best customers (based on order count or total spent). | ||
| − | ==Signup== | + | == Signup == |
If you do not yet have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create a free account here]. | If you do not yet have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create a free account here]. | ||
| Line 25: | Line 25: | ||
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. | # Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. | ||
# Locate the "'MailChimp'" module and click '''Activate'''. | # Locate the "'MailChimp'" module and click '''Activate'''. | ||
| − | # | + | # Grant addon access to your admin user role group (typically ''Full Administrator''). |
# Navigate to '''Addons > MailChimp'''. | # Navigate to '''Addons > MailChimp'''. | ||
| + | # Follow the instructions to finish the setup process. | ||
| − | + | == Creating a MailChimp API Key == | |
| − | + | You must provide a MailChimp API key as part of this process. If you do not have a MailChimp account, you can [https://go.whmcs.com/1297/mailchimp-create-account create a free account here]. | |
| − | |||
| − | You must provide a MailChimp API | ||
To create a MailChimp API key: | To create a MailChimp API key: | ||
# Log in to MailChimp. | # Log in to MailChimp. | ||
| − | # Navigate to '''Account > Extras > API keys'''. | + | # Navigate to '''Account > Extras > API keys'''. [[File:Mailchimp1.png|500px]] |
# Click '''Create A Key'''. A new key will be automatically generated for you. | # Click '''Create A Key'''. A new key will be automatically generated for you. | ||
| − | # Copy | + | # 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]] |
# 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]] | # 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]] | ||
| − | ==Creating an Automated Campaign== | + | == Creating an Automated Campaign == |
To create an automated campaign: | To create an automated campaign: | ||
| Line 52: | Line 51: | ||
# Choose the '''E-Commerce''' options.<br>[[File:Mailchimp4.png|500px]] | # 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 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. | + | ## Select ''Follow up on purchases''. This option sends email after an applicable purchase according to your settings. [[File:Mailchimp5.png|500px]] |
| − | ## Select ''Product category''. This option only sends email for purchases of specific types of product. | + | ## Select ''Product category''. This option only sends email for purchases of specific types of product. [[File:Mailchimp6.png|500px]] |
# Enter a name for your new automation (in this example, ''Follow up on SSL purchase''). | # 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. | # Choose the mailing list that you connected with your WHMCS installation. The campaign overview will display. | ||
| − | # Click ''Edit Trigger'' to choose the applicable product category. | + | # Click ''Edit Trigger'' to choose the applicable product category. [[File:Mailchimp7.png|500px]] This example uses ''SSL Certificates'' as the product category. [[File:Mailchimp8.png|500px]] |
# Click '''Save'''. | # Click '''Save'''. | ||
| − | # Design your campaign's emails. You must create at least one. | + | # Design your campaign's emails. You must create at least one. [[File:Mailchimp9.png|500px]] |
| + | |||
| + | == 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|Marketing Emails Automation]] | 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]] | ||
| Line 69: | Line 69: | ||
To do this: | To do this: | ||
| − | # | + | # Go to the WHMCS Admin Area and navigate to '''Reports > More'''. |
# Under '''Exports''', click '''Clients'''. | # Under '''Exports''', click '''Clients'''. | ||
# Select the fields to export. We recommend '''First Name''', '''Last Name''', '''Company Name''', and '''Email Address'''. | # Select the fields to export. We recommend '''First Name''', '''Last Name''', '''Company Name''', and '''Email Address'''. | ||
# Click '''Filter''' to generate the report. | # 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. | + | # 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. [[File:clients-csv-8-2.png|500px]] |
# Go to MailChimp. | # Go to MailChimp. | ||
| − | # Navigate to '''Lists''' and choose the list you want to import customers | + | # Navigate to '''Lists''' and choose the list you want to import customers to. |
# Navigate to '''Add contacts > Import contacts'''. | # Navigate to '''Add contacts > Import contacts'''. | ||
# Choose the CSV or tab-delimited text file option. | # Choose the CSV or tab-delimited text file option. | ||
# Click '''Next'''. | # Click '''Next'''. | ||
# Follow the displayed instructions to upload the CSV export and complete the import process. | # Follow the displayed instructions to upload the CSV export and complete the import process. | ||
Revision as of 15:07, 10 September 2021
MailChimp integration is available in WHMCS 7.3 and later.
Contents
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.
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).
Signup
If you do not yet have a MailChimp account, you can create a free account here.
Initial Setup
To set up integration with MailChimp:
- Navigate to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Locate the "'MailChimp'" module and click Activate.
- Grant addon access to your admin user role group (typically Full Administrator).
- Navigate to Addons > MailChimp.
- Follow the instructions to finish the setup process.
Creating a MailChimp API Key
You must provide a MailChimp API key as part of this process. If you do not have a MailChimp account, you can create a free account here.
To create a MailChimp API key:
- Log in to MailChimp.
- Navigate to Account > Extras > API keys.
- Click Create A Key. A new key will be automatically generated for you.
- 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).
- Enter the API key in WHMCS. You will see this screen the first time you access the MailChimp addon after activating it.
Creating an Automated Campaign
To create an automated campaign:
- Log in to your [MailChimp account].
- Navigate to Campaigns > Create Campaign.
- Choose Create an Email.
- Select the Automated tab.
- Choose the E-Commerce options.
- 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.
- Select Product category. This option only sends email for purchases of specific types of product.
- Select Follow up on purchases. This option sends email after an applicable purchase according to your settings.
- 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 Trigger to choose the applicable product category.
This example uses SSL Certificates as the product category. 
- Click Save.
- Design your campaign's emails. You must create at least one.
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:
- 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.
- 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.
