Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Dotdigital Destination


(new)

Beta

This feature is in active development and may change before general availability.

Destination Info
  • Accepts Page, Alias, Group, Identify and Track calls.
  • Refer to it as Dotdigital in the Integrations object
  • This integration is partner owned. Please reach out to the partner's support for any issues.
  • This destination is in Beta

Dotdigital(link takes you to an external page) is an all-in-one customer experience and data platform (CXDP) that empowers marketing teams to exceed customer expectations with highly personalized cross-channel journeys.

This destination is maintained by Dotdigital. For any issues with the destination, contact the Dotdigital Support team.


Getting started

getting-started page anchor
  1. From your workspace's Destination catalog page(link takes you to an external page) search for "Dotdigital".
  2. Select Dotdigital and click Add Destination.
  3. Select an existing Source to connect to Dotdigital (Actions).
  4. Log in to your Dotdigital account(link takes you to an external page). Expand the User menu in the bottom left and go to Settings > Access > API users.
  5. Note your API region (r1, r2 or r3) for step 7.
  6. Create a new API user(link takes you to an external page).
  7. In Segment, select your Dotdigital account region and paste the API user and API password in the Dotdigital destination settings.

Property nameTypeRequiredDescription
Regionselect
required

The region your account is in


Passwordpassword
required

Your Dotdigital password.


Usernamestring
required

Your Dotdigital username


Build your own Mappings. Combine supported triggers with the following Dotdigital-supported actions:

(information)

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Enrol Contact to Program

enrol-contact-to-program page anchor

Creates a program enrolment.

Enrol Contact to Program is a Cloud action. The default Trigger is type = "track" and event = "Enrol Contact to Program"

Property nameTypeRequiredDescription
Contact Identifier typeSTRING
required

Select the field to identify contacts.


Email AddressSTRING

Optional

The Contact's email address.


Mobile NumberSTRING

Optional

The Contact's mobile number.


ProgramSTRING
required

List of active programs

Remove Contact from List

remove-contact-from-list page anchor

Removes a Contact from a List.

Remove Contact from List is a Cloud action. The default Trigger is type = "track" and event = "Remove Contact from List"

Property nameTypeRequiredDescription
Contact Identifier typeSTRING
required

Select the field to identify contacts.


Email AddressSTRING

Optional

The Contact's email address.


Mobile NumberSTRING

Optional

The Contact's mobile number.


ListNUMBER
required

The List to remove the Contact from.

Adds a contact to a list.

Add Contact to List is a Cloud action. The default Trigger is type = "track" and event = "Add Contact to List"

Property nameTypeRequiredDescription
Contact Identifier typeSTRING
required

Select the field to identify contacts.


Email AddressSTRING

Optional

The Contact's email address.


Mobile NumberSTRING

Optional

The Contact's mobile number.


ListNUMBER
required

The list to add the contact to.


Data FieldsOBJECT

Optional

An object containing key/value pairs for data fields assigned to this Contact. Custom Data Fields must already be defined in Dotdigital.

Sends a transactional SMS.

Send Transactional SMS is a Cloud action. The default Trigger is type = "track" and event = "Send Transactional SMS"

Property nameTypeRequiredDescription
ToSTRING
required

Only valid mobile numbers with an international dialling prefix will be accepted (e.g. 447777123123).


FromSTRING

Optional

Enter a custom From name, or leave blank to use a random number. From name format varies by region. Learn more(link takes you to an external page)


MessageTEXT
required

The content of the SMS, up to 160 non-encoded characters per message.


Link ShorteningBOOLEAN

Optional

Link shortening(link takes you to an external page) will automatically shorten your links to save character count and track who clicked on them for better reporting. Defaults to No.


Allow Unicode CharactersBOOLEAN

Optional

If Yes, Unicode characters will be allowed in the message body. If No, any messages containing Unicode will not be sent. Please read why Unicode(link takes you to an external page) is important before switching this on. Defaults to No.

Sends a marketing email to a contact.

Send Email Campaign is a Cloud action. The default Trigger is type = "track" and event = "Send Email Campaign"

Property nameTypeRequiredDescription
EmailSTRING
required

A single email address to send the campaign to. If the contact does not exist in your Dotdigital account, the campaign won't be sent.


CampaignNUMBER
required

The campaign to email to a contact.


Send DateDATETIME

Optional

The campaign will be sent immediately if the send date is left blank.


Send Time OptimisedBOOLEAN

Optional

Send the campaign at the most appropriate time based upon their previous opens.

Send Transactional Email

send-transactional-email page anchor

Sends a transactional email.

Send Transactional Email is a Cloud action. The default Trigger is type = "track" and event = "Send Transactional Email"

Property nameTypeRequiredDescription
From AddressSTRING
required

Use either your default transactional email from address, or another custom from address you have added to your account. If you set a from address that is not listed in your available from addresses, Dotdigital will replace it with your default from address. You may set a from name as well as an email address, for example "My Company <Dotmailer123@r1.dotdigital-email.com>". Read more about using transactional email(link takes you to an external page).


To AddressSTRING
required

The email address(es) to send to.


SubjectSTRING
required

The subject line for your email.


HTML ContentTEXT
required

The HTML content for your email.


Plain Text ContentTEXT

Optional

The plain text content for your email.


CC AddressesSTRING

Optional

The CC email address(es) to send to. Separate email addresses with a comma. Maximum: 100.


BCC AddressesSTRING

Optional

The BCC email address(es) to send to. Separate email addresses with a comma. Maximum: 100.

Sends a marketing SMS to a contact.

Send SMS is a Cloud action. The default Trigger is type = "track" and event = "Send SMS"

Property nameTypeRequiredDescription
ToSTRING
required

The mobile number of the contact in E.164 format (e.g. 14155552671).


MessageTEXT
required

The message to send in the SMS.


Before using the Add Context to List Action, complete the following prerequisites:

Enroll Contact to Program

enroll-contact-to-program page anchor

When you use the Enroll Contact to Program action, Dotdigital creates a contact for the identifier you provide, if the contact doesn't already exist.

Only valid mobile numbers with an international dialing prefix in E.164 format will be accepted. This format is a combination of +[country code][phone number]. For example: +12133734253.

  • Only valid mobile numbers with an international dialing prefix in E.164 format will be accepted. This format is a combination of +[country code][phone number]. For example: +12133734253.
  • You must have SMS pay-as-you-go enabled to use this action. Learn more about how to enable SMS pay-as-you-go in Dotdigital's documentation(link takes you to an external page).

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo(link takes you to an external page).

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

(information)

Real-time to batch destination sync frequency

Real-time audience syncs to Dotdigital may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Regionselect
required

The region your account is in

Default: https://r1-api.dotdigital.com

Passwordpassword
required

Your Dotdigital password.


Usernamestring
required

Your Dotdigital username