Before you Begin
Before you begin, you will need to obtain authentication information from Dotdigital.
Steps to Obtain the Credentials from Dotdigital:
Go to Dotdigital and log in with your Dotdigital account credentials.
On the Dotdigital Home page, choose your account and then click Settings.
On the Settings page, click Access → API users. Dotdigital displays the API users page, which shows your API endpoint and a list of current users.
Click Add New API User.
Dotdigital assigns the user an email-style username. Enter a Description for the account, such as "iPaaS.com integration", and a Password.
Save the username and password — you will use them when configuring the subscription.
Select the Rate limiting type according to your account agreement.
Click Save to create the new user.
Installing the Dotdigital Integration
Go to Subscriptions Management → Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Dotdigital integration title.
Click the Subscribe button.
Enter the Name of the subscription and select a version. Use a relevant and unique name within the company where this subscription is created, for example Dotdigital - Production.
Enter the API User and the API Password provided when you created the new API user in Dotdigital.
Enter the Order Collection Name if order (transaction) data should be written to a Dotdigital insight-data collection other than the default. Leave it blank to use the default name Purchases. If you are upgrading a subscription configured before version 1.0.5, this setting was previously named Collection Name and its value is not carried across automatically — see the Dotdigital Background article.
Enter the product collection settings if you will transfer products or product categories. All three are optional, but they behave differently when left blank.
Product Collection Name: the collection that products and their variants are written to. Left blank, products are written to a collection named catalog and no error is raised, so set this deliberately rather than relying on the default.
Product Collection Type: whether that collection is created as a catalog collection, which takes part in Dotdigital's native product features such as product catalogs, recommendations and category filtering, or a custom collection, which stores the same data as plain insight data. Choose before the first product transfers: Dotdigital fixes a collection's type when it is created and it cannot be changed afterwards.
Product Category Collection Name: the collection that product categories are written to. This one has no default, so leaving it blank stops a category transfer with an error. It must share the same base name as Product Collection Name for a product's category references to resolve.
The integration adds a prefix based on the collection type, so the collection you see in Dotdigital is not named exactly what you enter — a catalog-type product collection appears as catalog_yourname and its categories collection as categories_yourname.
Enter the API Throttle Limit. This setting controls how many API requests can run simultaneously, protecting system performance and ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections — the maximum number of simultaneous API connections processed for the integration.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions — the maximum number of simultaneous batch executions for the integration.
Default Value: 5
Range: 10
Click Apply to save the settings.
Authentication Configuration
The Dotdigital integration authenticates with HTTP Basic authentication using the Dotdigital API user credentials.
API User: Location: Dotdigital Settings → Access → API users. Description: the API user's email-style username, used to authenticate every request to Dotdigital.
API Password: Location: set when the API user is created in Dotdigital. Description: the password for the API user.
Important Notes: Ensure the API user has permission to access the Contacts, insight data, and triggered campaign areas of the Dotdigital API, since the integration uses all three. The Dotdigital API endpoint is shown on the API users page and is specific to your account's region.
Post-Installation Verification
After completing the installation, perform these tests to verify the setup.
Connection Test
Confirm the subscription saved without an authentication error.
Data Sync Test
From the iPaaS.com Manual Sync page, send a sample Customer to Dotdigital using the iPaaS.com Customer ID.
Confirm the contact appears in Dotdigital.
Functionality Test
Run an end-to-end transfer for a contact, an order, and a loyalty certificate.
Validate field mappings and review the integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: API Introduction
Support Portal: https://support.ipaas.com/en/
Contact Information: Contact iPaaS.com
Dotdigital Support and Troubleshooting
Within Dotdigital, click the Help button to contact Dotdigital Support or to search their documentation.