You are browsing documentation for version 5.0 of OroCommerce, OroCRM, and OroPlatform, maintained until August 2024 and supported until March 2026. See version 5.1 (the latest LTS version) of the Oro documentation for information on latest features.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Available in OroCRM Available in OroCommerce

Configure Mailchimp Integration in the Back-Office

Configure Integration on the Mailchimp Side

To configure the integration with Oro application on the Mailchimp side, you need to create an API key. To do that:

  1. Login to Mailchimp.

  2. Navigate to your name in the upper right corner.

  3. Select Account.

    Navigate to the account menu

  1. Go to Extras > API keys.

    The API keys menu
  2. Scroll down to the bottom of the page and press Create a Key.

    Display the Create a Key button
  3. A newly created key will appear at the top of the list. Copy the key.

    Copy the newly created key

Configure Integration on the Oro Side

  1. Log into your Oro application and navigate to System > Integrations > Manage Integrations.

  2. Click Create Integration in the top right corner.

  3. Next, complete the following fields:

    Field Description
    Type Among other third-party services, choose Mailchimp as this is the integration we are configuring. A form specific to Mailchimp will be displayed.
    Name Specify the integration Name as it will be referred to within Oro application.
    API Key Paste the API key you copied in your Mailchimp account. Click Check Connection. Everything’s Chimpy means that the connection was successful and you are now authorized.
    Activity Update Interval Now set the Activity Update Interval to a period you plan to run your campaign for. This should be set based on the length of your campaign and data storage requirements specific to your Oro instance.
    Status Active or Inactive. By default, Status is set to Active.
    Owner The Owner determines the list of users who can manage the integration and the data synchronized with it. This means that the owner receives the data produced by the email campaign. All Entities imported within the integration will be assigned to the selected user. It is suggested to select a marketing rep as the owner.
    Enable Two Way Sync Use this section to enable or disable two-way synchronization. By default, Enable Two Way Sync is unchecked. If it remains unchecked, unsubscribes will pass from Mailchimp to Oro application. If enabled, subscription status can be passed from Oro application to MailCHimp and the other way around.
    Sync Priority: Remote Wins means that the Mailchimp will be considered the master and override conflicts with the Oro application. Local Wins means that local data will be the master and override any conflicts with Mailchimp.
  4. Click Save and Close.

The integration has been successfully configured and will now appear in the integration grid.

Sync Integration

In order to sync your integration:

  1. Navigate to System > Integrations > Manage Integrations.

  2. Select your newly created integration.

  3. Click Schedule Sync in the top right corner.


Business Tip

Technologies drive digital transformation in critical industries such as manufacturing. Learn how eCommerce can accelerate digital transformation in manufacturing.

Related Topic