Iterable is a cross-channel marketing platform that allows you to create, optimize, and measure every interaction across the entire customer journey. Treasure Data supports the Iterable platform by allowing users to add or remove subscribers from an Iterable list.

Introduction = What is This Thing?

To create an introduction, start with the PRD. The introduction should address the reader's question of "What is it?. The Technical Writer will review the introduction and make changes. 

PRD Problem Statements Example

Braze is a famous Customer Engagement Platform that connects the consumers and the brands. Their solution support pushing of targeted ads to the consumer-ends mobile applications and websites via their SDK. In addition, they scalable user profiles management as well as schedule cleaning up of the opt-out users and segments.

Technical Writer Final Version

The Braze platform provides insight into new growth opportunities and brand interactions that can help you build transformative campaigns and take strategic actions. Treasure Data supports the Braze platform by allowing you to write job results from Treasure Data directly to Braze. 


What can you do with this Integration?

Include a bulleted list (at least two bullets) of what the customer can do with the integration. 

PRD Use Cases Example

Use Cases

  • As a marketing operator, I want to incrementally send segmented users attributes to Braze, where I can easily create the segments based on these information for targeting correct consumers.

  • As a data engineer, I want to automatically map the custom Ids of the consumers to Braze unidentified users so that I can facilitate multiple marketing tools on the marketing campaign

  • As a marketing operator, I want to remove opt-out consumers from the list on Braze to provide the matching privacy level for the target consumers.

PRODUCT MANAGERS: Please condense the use cases into easily consumed bullets.

Technical Writer FInal Version

  • Map external ids: For example, you can map ids from your CRM system to the Braze user account. 

  • Opt-out: When an end-user updates the consent choosing not to participate.

  • Upload your own tracking of events, purchases, or custom profile attributes. This information can help you build precise customer segments that enhance the user experience for your campaigns.

Prerequisites

Obtaining API Key

For the heading, replace the current text, keep a Heading 1, and change the text color to black.

In this section, include information that the customer needs to set up the integration.

For example:

  • Obtain REST API Key
  • Fetch Data
  • Obtain/Define Credentials
  • Basic Usage
  1. Navigate to https://app.iterable.com/settings/apiKeys
  2. Select New API KEY
  3. Select Standard (Server-side)


Use the TD Console to Create Your Connection

Create a New Connection

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

Open TD Console.
Navigate to Integrations Hub Catalog.
Search for and select Iterable.

Select Create Authentication.
Type the credentials to authenticate.
Type a name for your connection.
Select Done.


Define your Query

For adding subscribers, the connector only supports these fields.

NameTypeDescription
emailString
data_fieldsJSON
user_idString
prefer_user_idBooleanPrefer user_id over email
merge_nested_objectsBoolean


For removing subscribers, the connector only supports these fields

NameTypeDescription
emailString
user_idString

Example Query

SELECT email, user_id
FROM table my_table

Use Query Export Result to export data


Integration Parameters for Iterable

Set the following parameters:


ParameterValuesDescription
actionStringadd/remove
list_idNumber
campaign_idNumber
channel_unsubscribeBoolean
skip_invalid_data
Boolean

Use Audience Studio to schedule and view your activation

  1. Open TD Console.
  2. Navigate to Audience Studio Segments & Funnels.
  3. Select the Segment for activation, right-click and select Create Activation.
  4. Enter the activation name and select the created Iterable authentication.
  5. Set the integration parameters for Iterable.
  6. Navigate to Output Mapping tab, uncheck Export All Columns to define column mapping from your segment schema to the export query. See supported fields in the previous section: Define your query.
  7. Navigate to Schedule tab to schedule the activation (optional).
  8. Click Create or Create & Run Now to create/run the activation.
  9. You can view the activation status and log in Workflows by selecting the pop-out beside the last attempted activation from the Activations tab.
     
  10. From the Workflow Logs tab, you can view the specified data, which may include such output results as "total", "skipped", "succeed", or "fail" record counts and the invalid data during validation, as well as any API errors in the case the data is returned via API. 

     


Optionally Schedule the Query Export Jobs

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


Optionally Configure Export Results in Workflow

Within Treasure Workflow, you can specify the use of this data connector to export data.

Learn more about Using Workflows to Export Data with the TD Toolbelt.

Example Workflow for Iterable


_export:
  td:
  database: td.database

+iterable_export_task:
  td>: export_iterable.sql
  database: ${td.database}
  result_connection: iterable
  result_settings:
    type: iterable
    action: add
    list_id: 769207
    skip_invalid_data: false