Dotdigital Integration module

Edition

Incubator (services)

Git

Latest

1.0

Compatible with Magnolia 6.2.

The Dotdigital Integration module allows you to connect and leverage the features of Dotdigital, a customer experience and data platform.

Prerequisites

You should have a Dotdigital account.
You must have a Dotdigital API user. This user and associated credentials ensure authentication for operations and method calls between Magnolia and Dotdigital.

This module is at the INCUBATOR level.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.marketing</groupId>
  <artifactId>dotdigital-integration</artifactId>
  <version>1.0</version>
</dependency>

Configuration

After installing the module, you’ll need to make sure the following fields under Dotdigital configuration:

apiPwd is your Dotdigital API password.
apiUsername is your Dotdigital API username.
baseApiUrl is your Dotdigital API base URL.

mgnl config

Usage

This section helps you get accustomed with using the Dotdigital Integration module. There are several Dotdigital apps:

Configuration
Address books
Contacts
Campaigns
Segments

mgnl apps

Connect Magnolia forms to Dotdigital

Integrate Magnolia forms with Dotdigital, allowing the contact data submitted in Magnolia to go to Dotdigital.

SentContactToAddressBook:
  class: info.magnolia.marketing.dotdigital.form.processors.SendContactToAddressBookProcessor
  addressBookId: 216615 (1)
  enabled: true

1	The ID of the address book in Dotdigital.

Manage Dotdigital in Magnolia

You can also manage certain elements of Dotdigital directly from Magnolia’s AdminCentral such as:

Address Books
Contacts
Segments
Campaigns

Address Books

For Address Books, you can:

List address books
Add an address book
Edit an address book
Manage an address book (e.g., delete unused contacts)

mgnl addressbook

Contacts

For Contacts, you can:

List contacts
Add a contact
Edit a contact
Remove contact(s)

mgnl contacts

Segments

For Segments, you can:

List segments
Refresh (update) segments

mgnl segments

Campaigns

For Campaigns, you can:

List campaigns
Add a campaign
Edit campaigns
Remove campaign(s)

Campaigns
Campaigns preview

mgnl campaigns

mgnl campaign preview

Changelog

Version Notes

Version	Notes
`1.0`	Initial release of the module.

1.0

Initial release of the module.