Skip to main content

Dotdigital Installation Instructions

Step-by-step setup for the Dotdigital integration on iPaaS.com — create a Dotdigital API user, subscribe, and configure the subscription settings.

Before you Begin

Before you begin, you will need to obtain authentication information from Dotdigital.

Steps to Obtain the Credentials from Dotdigital:

  1. Go to Dotdigital and log in with your Dotdigital account credentials.

  2. On the Dotdigital Home page, choose your account and then click Settings.

  3. 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.

  4. Click Add New API User.

  5. 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.

  6. Select the Rate limiting type according to your account agreement.

  7. Click Save to create the new user.

Installing the Dotdigital Integration

  1. Go to Subscriptions Management → Subscriptions and click Search Certified Integration Marketplace and Subscribe.

  2. Click the Dotdigital integration title.

  3. Click the Subscribe button.

  4. 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.

    Dotdigital subscription settings page in iPaaS.com

    5. Enter the API User and the API Password provided when you created the new API user in Dotdigital. 6. Enter the 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. 7. 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 8. 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 9. Enter the number of Concurrent Connections — the maximum number of simultaneous API connections processed for the integration. - Default Value: 5 - Range: 10 10. Enter the number of Concurrent Batch Executions — the maximum number of simultaneous batch executions for the integration. - Default Value: 5 - Range: 10 11. Click Apply to save the settings.

Authentication Configuration

The Dotdigital integration authenticates with HTTP Basic authentication using the Dotdigital API user credentials.

  • API UserLocation: Dotdigital Settings → Access → API users. Description: the API user's email-style username, used to authenticate every request to Dotdigital.

  • API PasswordLocation: 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

  1. Confirm the subscription saved without an authentication error.

Data Sync Test

  1. From the iPaaS.com Manual Sync page, send a sample Customer to Dotdigital using the iPaaS.com Customer ID.

  2. Confirm the contact appears in Dotdigital.

Functionality Test

  1. Run an end-to-end transfer for a contact, an order, and a loyalty certificate.

  2. 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.

Dotdigital Support and Troubleshooting

Within Dotdigital, click the Help button to contact Dotdigital Support or to search their documentation.


Related Documents

Did this answer your question?