Integration with MailChimp¶
OroCRM supports out of the box integration with MailChimp, allowing you to do the following:
- Map OroCRM Marketing Lists and Magento Abandoned Cart Campaigns to segments of MailChimp Subscriber’s Lists and keep them synchronized.
- Use the segments of MailChimp Subscribers Lists to create email campaigns in MailChimp and import them to OroCRM.
- Use the segments based on the Abandoned Cart Campaigns to automate the mailings.
- Use MailChimp campaign statistics and OroCRM reporting tools to analyze the campaign efficiency.
This article describes how to define and edit the integration and synchronization settings.
While MailChimp integration capabilities are pre-implemented, OroCRM can be integrated with different third-party systems.
On the MailChimp Side¶
The only thing you will need on the MailChimp part is your API Key value:
Open your account and go to the Account page.
Go to the Extras → Api Keys
Click the Create A Key button below the list of your API keys.
Find the new key in the list and copy the API key value.
On the OroCRM Side¶
Install the “OroCRM MailChimp Integration” extension (oro/crm-mail-chimp)
Create MailChimp Integration¶
- Go to the “System → Integrations → Manage Integrations” and click the Create Integration button.
- The “Create Integration” form will appear.
- As soon as you’ve set the integration type to “MailChimp”, the form will be recalculated to meet specific integration requirements.
Define the following mandatory details in the “General” section:
|Type*||The integration type. Must be set to MailChimp|
|Name*||The integration name used to refer to the integration within the system.|
|API Key*||The API key generated and/or copied in the MailChimp account (as described above).|
Limits the list of users that can manage the integration and all the entities imported within the integration to only those, whose roles allow managing integration and corresponding entities assigned to the owner (e.g. the owner, members of the same business unit, system administrator, etc.)
By default, the field is filled in with the user creating the integration.
After the API Key has been entered, you can click the Check Connection button, to see if the key has been entered correctly.
Use the Synchronization Settings section to enable/disable two way synchronization.
Check Enable Two Way Sync box, if you want to download data both from MailChimp to OroCRM and back. If the box is left unchecked, data from MailChimp will be loaded into OroCRM, but changes performed in OroCRM will not be loaded into MailChimp.
If two-way synchronization is enabled, define the priority used for the conflict resolution (e.g., if the same customer details were edited from the both OroCRM and MailChimp):
- Remote wins: MailChimp data will be applied to both MailChimp and OroCRM.
- Local wins: OroCRM data will be applied to both MailChimp and OroCRM.
For example, we have created a Demo MailChimp Integration with two-way synchronization enabled, where if the same data is changed in both MailChimp and OroCRM, the MailChimp changes will take precedence.
After the integration has been created and its status has been set to Active, the list of Subscribers Lists will be automatically imported from MailChimp to OroCRM for further integration management.
Map OroCRM Marketing Lists to MailChimp Subscribers List¶
Now you can map contacts of an OroCRM Marketing List or Magento Abandoned Cart Campaigns to a segment of a subscribers list in MailChimp.
- Go to Marketing → Marketing Lists or Marketing → Abandoned Cart Campaigns and open the list that you want to use.
If a marketing list is suitable for the connection, the Connect to MailChimp button will appear on the View page of the marketing list.
Click the button. The “Connect To MailChimp” form will emerge.
Define the following fields:
|MailChimp Segment Name*||Name used to refer to the segment created in MailChimp, where the contacts will be mapped.|
|MailChimp Integration*||Contains all the MailChimp integrations that are available in the OroCRM instance. Select the integration, for which the mapping must be performed.|
|MailChimp Subscribers List*||Contains all the MailChimp Subscribers List records available for connection.|
Now you can use the segment in the Subscribers List record to create Email Campaigns in MailChimp. If the segment is based on an Abandoned Cart Campaign, you can also use it for Automation in MailChimp.
Start the Synchronization¶
After the connection has been saved, contacts from the marketing list will be automatically exported from OroCRM to the chosen segment of MailChimp. After this, data synchronization between OroCRM and MailChimp will be performed automatically.
You can also start the synchronization manually. To do so:
- Click the Synchronize button in the MailChimp menu on the View page of the Marketing List
- You can also start the data synchronization from the View page of the integration, with the Schedule Sync button.
- You can also start the data synchronization with the button in the “System → Integrations → Manage Integrations” section.
During the synchronization, the following details are updated:
- The list of Subscribers lists available in MailChimp is updated in OroCRM
- The list of contacts on a specific OroCRM marketing list and related segment of a MailChimp marketing list are checked against each other and updated, subject to the priority defined in the synchronization settings of the integration.
- Email campaigns created in MailChimp are imported as Email Campaign records in OroCRM.
- Statistics collected in MailChimp are imported to OroCRM as Campaign Results of the Email Campaign.
Manage the Integration¶
All the integrations created will be available in the Integrations grid under “System → Integrations → Manage Integrations”. You can use the grid action icon for the following:
- Delete the integration –
- Get to the Edit page of the integration –
- Start the data synchronization –
On the View page of a specific marketing list you can Click the MailChimp drop-down menu for the following:
- Start synchronization manually
- Change the connection settings for the list
- Disconnect the list from the segment