Important

You are browsing the documentation for version 1.6 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

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

Available in OroCRM Available in OroCommerce

Configure dotmailer Integration

Install Extension

To configure dotmailer integration, ensure that you have the dotmailer extension installed in your application. For installation instructions, click here.

Create API Managed User on the dotmailer Side

To configure integration with OroCRM and OroCommerce on the dotmailer side, create an API managed user:

  1. Log in to dotmailer.

  2. Navigate to your name in the upper-right corner of the page.

  3. Click Users in the dropdown menu.

  4. Select the API Users tab.

  5. Click the New User button.

    ../../../../../../_images/dotmailer_account_users.jpg

    Your unique email address will be generated in the Email Address field. You need this email address to configure OroCRM integration with dotmailer.

  6. Next, create and confirm your Password. The Description field is optional. Mark your user Enabled and click Save to proceed.

    ../../../../../../_images/dotmailer_api_users_new_user_details.jpg

Create Integration on the Oro Application Side

  1. Navigate to System > Integrations > Manage Integrations in the main menu.

  2. Click Create Integration in the upper-right corner of the page.

    ../../../../../../_images/oro_create_dotmailer_integration_new.jpg

  3. Complete the following fields:

    Field Description
    Type Select dotmailer from the list of integrations available in the dropdown.
    Name Enter the integration name to refer to within the system.
    Username Enter an API user name from your dotmailer Manage users page.
    Password Enter the password you set for your API user on the dotmailer side. Click Check connection. Connection Successful message indicates that connection to dotmailer has been established.
    Client ID The dotmailer uses OAuth 2.0 to provide single sign-on. Client ID is the ID of the OAuth 2.0 making the request. Single sign-on provides the means for a dotmailer user to log into their account just once, removing the need to constantly re-enter credentials. To register to use OAuth you will need to be on an dotmailer Enterprise license and to contact your dotmailer account manager. More information on sign-on is available in the Configure Single Sign-on section of the guide.
    Client Secret key The pre-shared client secret, used to authenticate your application when making token request.
    Custom OAuth Domain Enter custom domain if it is used in dotmailer. By default https://r1-app.dotmailer.com/ is used.
    Default Owner Select the owner of the integration. The selected user will be defined as the owner for all the records imported within the integration.

  4. Once all the details of the integration have been specified, click Save and Close.

As soon as the integration is successfully configured, it will appear in the integration grid.

../../../../../../_images/oro_dotmailer_integration_grid.jpg

In addition, dotmailer menu group will become available under Marketing in the main menu.

The dotmailer menu group contains the following sections:

../../../../../../_images/o_dotmailer_main_menu.jpg

Sync dotmailer Integration

To sync dotmailer integration:

  1. Navigate to System > Integrations > Manage Integrations.
  2. Select the newly created integration.
  3. Click Schedule Sync in the upper-right corner of the page.