For an integration to successfully pass our verification process, there are a number of mandatory requirements. You should be sure that you can fulfil these before you begin the process for you integration to become verified.

We also provide some suggestions for desirable features which, if included in your integration, provide the best experience for users.

Mandatory requirements

To ensure that verified integrations offer great performance, and are robust and reliable for our mutual customers, we require the following criteria to be met by any integration that wants to be verified.

Securely acquire and store API credentials

Your integration must ensure that Dotdigital API user credentials are captured and stored securely, meaning that at minimum you must:

Ensure that the password field in any UI does not reveal the whole of the entered password.
Ensure that provided credentials are stored encrypted at rest in a secure, non-public-facing data store.

Automatically detect Dotdigital region

Dotdigital has three region-specific instances, so your integration must be able to automatically determine which regional domain it needs to use when making API calls for a mutual customer.

Learn more in the section Region-specific endpoints.

To do this we recommend the following approach:

In your integration setup flow, when a user enters their API credentials, call Get account information to determine:
- if the credentials entered are valid, and, if yes;
- the regional endpoint you should use for future API calls for this account.
When calling Get account information use the region 1 endpoint (r1-api.dotdigital.com). If the call succeeds you can determine the correct regional endpoint to use by reading the returned value ApiEndpoint, for example, https://r1-api.dotdigital.com/.

Use tiered rate limiting

To ensure your integration can utilize the best possible API call rates your integration must fully support our tiered call rate limiting including the recommended back-off behavior should call rates be exceeded.

Learn more in the Tiered rate scheme and How should I handle backing off? sections of our developer documentation.

Accommodate our error handling

Your integration must understand our error handling strategy for the API calls it makes, so that it can detect and handle errors gracefully, and provide the necessary information back to our mutual customer to resolve any problems.

Learn more in Error handling.

Use our most recent API version

If syncing contact data or channel subscription statuses we expect verified integrations to take advantage of our recently updated Contacts API service. This API works with all identifier types and channels, and is more efficient and simpler to utilize than previous iterations.

Learn more in Contacts.

Implement installation tracking

So that we can track and show mutual customers which integrations are enabled in their Dotdigital account, all verified integrations must pass an installation tracking token.

Learn more in Verified integration tracking.

Provide quality documentation

All verified integrations must be fully documented so that mutual customers can easily understand the functionality and how to configure the integration.

Documentation should cover:

A comprehensive overview of the functionality and features the integration provides.
Clear guidance on how to set up the integration, ideally with screenshots.
Explanations detailing any options or settings the integration has.
A reference guide to any data or fields created within Dotdigital by the integration:
- Any marketing preferences or data field values being mapped across and how are these are managed.
  Include contact data field or preference names.
- What data is synced in what direction.
- Insight data collections schema, if used.

Comply with our brand guidelines

When referring to Dotdigital, you must comply with our brand guidelines and use the correct logo.

View our brand guidelines

Download the Dotdigital logo pack

Desirable features

The following features and concepts are highly encouraged for adoption by our partners where applicable, however are not required for verification to be achieved successfully.

Support for Easy Editor Extensions

The key to successful integrations is to make them as simple as possible, so customers are able to quickly realize the potential and opportunities they provide. Many integrations do a great job of bringing contact and Insight data into or out of Dotdigital, but don’t do the best job of helping users to discover and easily implement valuable use cases and realize the full benefits of integrating.

When you create an integration, you should consider whether users could benefit from the ability to create user-friendly drag-and-drop content blocks that work directly in the Dotdigital EasyEditor.

Learn more in EasyEditor Extensions.

Program templates

Our program builder offers a powerful way to craft automated journeys to send personalized and engaging communication and realize marketing strategies.

Learn more in the Program builder section of our Help Centre.

If you create program templates that provide great examples of how to get value from your integration within Dotdigital, reach out to your assigned partner engineer to discuss their inclusion with our existing platform templates.

Campaign templates

We offer a global set of campaign templates as well as account-specific templates to create personalized and engaging communications and campaigns.

If you create campaign templates customized to your integration, you can:

reach out to your assigned partner engineer to discuss their inclusion in our global templates
use our Create template API to create examples in users’ Dotdigital accounts automatically. This is a great option when the content is specific to a given user.