Dotdigital Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Dotdigital Engagement Cloud is an omnichannel marketing solution that sends data-triggered campaigns across email, SMS, social media, push notifications, and more. You can write job results from Treasure Data directly to Dotdigital.

Prerequisites

• Basic knowledge of Treasure Data, including the TD Toolbelt.
• An account in Dotdigital.
• An API account in Dotdigital.

Limitations

• Treasure Data does not create a campaign.
• A transactional email action does not count over the rate limit of API calls.
• As per the rate limit of dotdigital API (https://developer.dotdigital.com/docs/getting-started-with-the-api#restrictions), one Upload bulk contacts action requires two API calls, which count into the overall rate limit.

Obtain Your API Account

1. Log in to DotDigital. Navigate to https://login.dotdigital.com/login.aspx?ReturnUrl=/.

2. Navigate to https://r1-app.dotdigital.com/access/api and select the API users tab**.**

   

3. Select New user. DotDigital provides you with an email address. Complete the form by adding and confirming a password; a description is optional.

   

4. Click Save.

Create a New Connection with TD Console

In Treasure Data, you must create and configure the data connection for export before running your query. As part of the data connection, you provide authentication to access the integration.

1. Open the TD Console.

2. Navigate to the Integrations Hub > Catalog.

3. Click the search icon on the far right of the Catalog screen, and enter dotdigital.

4. Hover over the dotdigital connector and select Create Authentication.

   

5. The New Authentication dialog opens.

   

6. Select your Region. The API User Name and API User Password fields auto-populate.

7. Select Continue.

8. Type a name for your connection.

9. Select Done.

Configure Export Results in Your Data Connection

Next, you need to create or reuse a query. In the query, you configure the data connection. You might need to define the column mapping in the query.

Configure the Connection by Specifying the Parameters

1. Open TD Console.

2. Navigate to Data Workbench > Queries.

3. Select the query that you plan to use to export data.

4. Run the query.

5. Select Export Results, located at the top of your query editor.

   The Choose Integration dialog opens.

6. You have two options when selecting a connection to use to export the results:

• Use an existing connection:

  • Type the connection name in the search box to filter.
  • Select your connection.

• Create a new Dotdigital connection.

  • Complete the field values to create a new connection.

Type the required credentials for your new Dotdigital connection. Set the following parameters.

Export Mode for Transactional Email

• Sample Configuration

Export Mode for Bulk Contacts

• Sample Configuration

Export Mode for Unified Contacts

• Sample Configuration

Upload Operation

Delete Operation

Example of a Query to Populate Dotdigital

From Treasure Data, run the following query and export results into a connection for Dotdigital. Transactional emails use case-sensitive column names, while bulk contacts use case-insensitive column names.

• Transactional Emails Query

SELECT an_email_column AS email,
another_first_name AS FIRSTNAME
another_first_name AS LASTNAME
FROM your_table;

• Bulk Contacts Upload Query

SELECT an_email_column AS email,
another_first_name AS firstname
another_first_name AS lastname
FROM your_table;

• Bulk Contacts Delete Query

SELECT contact_id AS id FROM your_table;

• Unified Contacts Query

Upload Operation

SELECT match_identifier, contact_id, email, mobile_number, channel_properties, consent_records, firstname, lastname FROM your_table;

Delete Operation

SELECT match_identifier, contact_id, email, mobile_number FROM your_table;

Data Model

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

Configure Export Results in Workflow

Example Workflow Exporting Transactional Email

timezone: UTC

_export:
  td:
    database: sample_datasets

+export_to_dotdigital:
  td>: queries/sample.sql
  result_connection: my_dotdigital_output
  result_settings:
    campaign_id: 119178
    mode: transactional_email
    ignore_invalid_records: true
    json_columns: ORDER, ITEMS

Example Workflow Exporting Bulk Contacts Upload

timezone: UTC

_export:
  td:
    database: sample_datasets

+export_to_dotdigital:
  td>: queries/sample.sql
  result_connection: my_dotdigital_output
  result_settings:
    campaign_id: 119178
    mode: bulk_contacts
    ignore_invalid_records: true
    merge_option: update_all
    add_to_address_book: true
    address_book_id: 119178
    export_operation: upload
    address_book_name: "address_book_name"
    address_book_identifier_mode: name
    create_when_not_found: true
    new_address_book_visibility: private

Example Workflow Exporting Bulk Contacts Delete

timezone: UTC

_export:
  td:
    database: sample_datasets

+export_to_dotdigital:
  td>: queries/sample.sql
  result_connection: my_dotdigital_output
  result_settings:
    campaign_id: 119178
    mode: bulk_contacts
    ignore_invalid_records: true
    address_book_id_delete: 119178
    export_operation: delete
    address_book_name_delete: "address_book_name"
    address_book_identifier_mode_delete: name

Example Workflow Exporting Unified Contacts Upload

timezone: UTC

_export:
  td:
    database: sample_datasets

+export_to_dotdigital:
  td>: queries/sample.sql
  result_connection: my_dotdigital_output
  result_settings:
    mode: unified_contacts
    ignore_invalid_records: true
    unified_cts_export_operation: upload
    unified_cts_merge_option: overwrite
    unified_cts_add_to_list: true
    unified_cts_list_identifier_mode: id
    unified_cts_list_id: 119178

Example Workflow Exporting Unified Contacts Delete

timezone: UTC

_export:
  td:
    database: sample_datasets

+export_to_dotdigital:
  td>: queries/sample.sql
  result_connection: my_dotdigital_output
  result_settings:
    mode: unified_contacts
    ignore_invalid_records: true
    unified_cts_export_operation: delete

For more information on using integrations in a workflow to export data, see Using Workflows to Export Data with TD Toolbelt.