Knowledge Base

Browse our knowledge base articles to quickly solve your issue.

Integrating Workbooks and Constant Contact

Workbooks can be integrated with Constant Contact, which is a cloud-based email marketing platform. The integration allows you to synchronise Workbooks Campaign Members into Constant Contact as lists. Each Campaign in Workbooks creates a separate 'list' in Constant Contact.

The opt-in/opt-out status between the Workbooks Campaign and Constant Contact will be maintained, so if a recipient opts out of an email in Constant Contact then the email opt-out flag is set on the Person or Lead record in Workbooks. You can then use Constant Contact to send your Campaign.


  • You have the capability to access the Configuration Landing Page.
  • You know your login details for Constant Contact.
  • The Mail Shots third party integration module has been switched on.
  • The Constant Contact Module has been selected. This can be done by navigating to Start > Configuration > Users & Security > Licences & Modules > Modules. Ensure the checkbox next to Constant Contact integration has been ticked.

Setting up your Constant Contact Integration

Navigate to Start > Configuration > Email & Integration > Constant Contact API

Copy the Redirect URL information and keep it as it is required at a later point in the setup. Next, create a new Constant Contact API key by clicking on the hyperlink provided. At this stage, you'll be taken to a new tab within your browser where you'll be asked to enter your Constant Contact login details.

Once you have logged in you need to follow the link for requesting a new API Key. You're required to enter information regarding the Constant Contact Integration. Enter Workbooks in the API Key Display Name field, a valid email address and set Multiple Accounts to No

Next, paste the Workbooks redirect URL that you copied earlier into the field called Redirect URL: (used in OAuth 2.0 requests). Then confirm you've read and accepted the Constant Contact API Terms and Conditions and then select Request an API Key. You'll now be shown details of the API key you've just generated.

The next step is to allow Workbooks to communicate with your Constant Contact account. Return to your Constant Contact form in Workbooks, select Authorise Workbooks API access and follow the wizard.

When you select Authorise Workbooks API access a new window will appear asking for further authorisation information. (If this window doesn't appear, it is likely that your browser's popup blocker has prevented it from doing so. It's worth checking your browser settings to prevent this from happening.)

You will be asked for your Constant Contact API Key (previously generated). After this, you will be asked if you want to grant access to your Constant Contact account, which you should allow. Following this, you will be asked to enter your Consumer Secret Key (also previously generated). After you have entered this a screen will appear stating that Workbooks has been authorised to access your Constant Contact account via their API.

Constant Contact Attribute Mappings

As well as synchronising names and email addresses between Workbooks and Constant Contact you can also synchronise other fields between the two systems. This is controlled using the Attribute Mappings table.

You can control which fields in Workbooks are available for use within emails generated in Constant Contact. These can be added by clicking Add and using the drop-down list to select the appropriate Workbooks Field Name. Notice that if a field is only available for either a Person record or a Sales Lead record this is shown in brackets after the field name.

Fields that are common to both Sales Leads and People are not followed by anything in brackets. You can then map these fields to a specified Custom Field within Constant Contact.

Synchronising a Workbooks Campaign with Constant Contact

Now that you've configured the integration you can create a Campaign within Workbooks and synchronise it with Constant Contact. Guidance on how to create a Workbooks Campaign can be found here.

To synchronise your Campaign with Constant Contact, on the Campaign Record select the Constant Contact Integration button. Follow the steps in the wizard that appears.

NOTE: If you also have Workbooks integrated with MailChimp, the first page of the wizard will give you the option to select either MailChimp or Constant Contact.

Script to push Workbooks Campaigns into Constant Contact

When you've completed the Constant Contact integration wizard the Workbooks Campaign is automatically synchronised to Constant Contact using a script that runs periodically. The script runs at regular intervals to accommodate any additional changes made to the Campaign since it was last synchronised with Constant Contact. These intervals can be specified to meet your requirements.

To view or change the interval click Start > Configuration > Automation > Processes and select the process on the right called '_Sync to Constant Contact list'. 

Viewing Lists in Constant Contact

Now that the script has run you can view your Workbooks Campaign and its Members within Constant Contact. Click on the Contacts option at the top of the Constant Contact homepage.

Here you'll see the lists which are stored within Constant Contact.  You will have a list called All Workbooks Contacts and a list called Constant Contact Test. The first list stores all the Members which belong to Workbooks Campaigns and have been synchronised with Constant Contact.

The latter represents the individual Workbooks Campaign that has been synchronised. The Constant Contact list takes its name from the value in the public name field of the corresponding Workbooks Campaign.  

Within each list, you can drill down to see the individual members of that list. If a Marketing Campaign member is removed from the Campaign or their Campaign Email Status is changed to unsubscribe then that member will be removed from the corresponding Constant Contact list.

Emailing from Constant Contact

You can use the wizard within Constant Contact to send your mailshot. To do so click on the 'Emails Tab' and then 'Create'. Within the design wizard, there are a number of predesigned email templates which can be used as they are or customised to send to your list members. Alternatively, Constant Contact allows you to create your own template using the editor provided. If you have the correct HTML skills, you can create a template from scratch.

Once you have designed your email you can send it to its recipients. At the 'Schedule' stage of the wizard, you are required to enter some final information, such as the subject title, the list you wish to send to and the from/reply-to email address. You then have the option to either 'Send Now' or 'Schedule', with both doing exactly what they state.

Reporting with Constant Contact

Once you have sent your email campaign it is possible to see information on who (if anyone) has opted out of email. This can be seen on the Email tab on the Marketing Campaign record.

Related content

Records can be synchronised between Workbooks and MailChimp automatically which enables you to report on how many emails were delivered, opened, bounced etc

Marketing Campaigns can be used to track interactions with targeted groups of People/Organisations or Leads, perhaps for Events or Mail Shots