Support Guide



  1. – Locate Your MailChimp API Key
  2. – Create Your MailChimp List
  3. – Activate The MailChimp Add-on
  4. – Sync Your Customer Details
Where do I access this in Checkfront?
You can access the MailChimp add-on from the main menu at Manage > Add-ons


Using the MailChimp Add-on With Checkfront

If you are an existing MailChimp user, or are looking for a good email campaign manger, you can now directly integrate MailChimp with your Checkfront account.

MailChimp is email marketing service that lets you design, send, and track HTML email campaigns with a simple set of tools. MailChimp offers a free account if you manage a list of less than 1,000 users and send less that 6000 emails a month.

Once configured and enabled, customers will be asked if they’d like to subscribe to your newsletter or mail list at the time of booking. When a booking is made and the user opts-in via the booking form, Checkfront will automatically subscribe them to the specified list in your MailChimp account.

To use this extension, you need a valid MailChimp account and an API key.

How to Locate Your MailChimp API Key

First you need to log into your MailChimp account. After you have successfully logged in, you will need to locate your API key within your account details section. These screenshots may differ in the event that MailChimp revises their website.

Click on your account name in the menu bar and then click on Account

Mailchimp Menu
From the Extras menu, choose API Keys
Mailchimp API Menu


Click on the Create A Key button to generate a new API key. Copy the new key to your clipboard, as you will need it a bit later on the Checkfront side of the configuration. It’s okay if you have more than one API key in your Mailchimp account. You may have different keys for different applications.

Create API Key



Create Your MailChimp List

In order to synchronize your Checkfront customers with MailChimp, you will need to create a new mailing list from within your MailChimp account.

Click on the Lists menu at the top and then the Create List button, over on the right.

After creating your new list, or if you already have one in place, it will be visible directly underneath, as shown by the red arrow below.

Create Mailchimp List



Activate The MailChimp Add-on

Log into your Checkfront account, navigate to Manage > Add-ons and look for the MailChimp extension among the other Checkfront add-on tiles.

Hover your mouse over the MailChimp tile and click on the setup link as shown below.

Mailchimp Activate in Checkfront

In the pop-up window, paste in the API Key you created earlier and enter the opt-in label you would like to appear on your booking form. Click Activate to complete.

You’ll now be presented with another pop-up window. This time, you’ll be able to select a mailing list from within your MailChimp account. If you only have one list, it will be selected for you automatically. The number in brackets shows the number of email addresses that are already assigned to the list.

Mailchimp Setup Complete

You can also choose whether you’d like to send out a verification email to the customer. This requires them to click on a link in the email to verify who they are, before their email address can be added to the list. This will help to cut down on SPAM. A welcome email can also be selected if you like. Both of these emails can be edited for content within the MailChimp interface.

Finally, you must map the merge tags between your booking form at Checkfront and the mailing list at MailChimp. The list of fields you see in the pop-up window are from your Checkfront account. Click on one of these to pull up a drop-down menu of fields from MailChimp. When you’ve completed the mapping, click Update.

Mailchimp Merge Tags

That’s it! The MailChimp extension is now ready to be used. A new field will be added to the end of your booking form and if checked, the customer’s email address will be added to your MailChimp database once they have completed their booking.
MailChimp Newsletter



Sync Your Customer Details

To ensure that the name and email addresses of your customers sync to your MailChimp account properly, the two booking form system fields for the name and email address of your customers must be active.

The two system field IDs must be customer_name and customer_email.