You can directly import data from Intercom to Treasure Data.

Prerequisites

Use the TD Console to Create Your Connection

Create a New Connection

Go to Integrations Hub > Catalog and search and select Intercom.


Select Create. You are creating an authenticated connection.

The following dialog opens.


Access to Intercom requires OAuth2 authentication.

Select Click here to connect to your Intercom account.

Enter your credentials to sign into Intercom.


After you grant access to Treasure Data you are redirected back to TD Console. Choose the Intercom connector again, then choose the OAuth Authenticate method. You will see an OAuth connection with your account name in the dropdown list. Choose the account you want to use and then proceed to create the connection..



Name your new Google Drive Connection. Select Done.


Previously for this data connector, App id and API Key was used for authentication. However, Intercom started their OAuth flow and Intercom API keys were deprecated.

If you are using Google Sign-In to log into Intercom, make sure that you are already logged in Intercom before starting the OAuth flow. Intercom requires password logins, not Google Sign-In, through the OAuth flow.

Update an existing API key-based connection to OAuth.

Initiate the OAuth flow as you did previously, even if you have been using API keys. OAuth is prioritized over API keys, if both are specified.


Transfer Your Data to Treasure Data

After creating the authenticated connection, you are automatically taken to the Authentications tab. Look for the connection you created and select New Source.

Import From Users and Conversations:

From Source select users or conversations.



Parameters:

Import From Tags and Segments:

From Source choose tags or segments



Data Preview 




Choose the Target Database and Table

Choose an existing source or create a new database and table.


Create a new database and give your database a name. Complete similar steps to Create new table.

Select whether to append records to an existing table or replace your existing table.

If you want to set a different partition key seed rather than use the default key, you can specify one using the popup menu.


Optionally Schedule the Job

You can use Scheduled Jobs.


Details

Name your Transfer and select Done to start.




Use Command Line


Install ‘td’ command v0.11.9 or later

You can install the newest TD Toolbelt.

$ td --version
0.15.0


Create Configuration File

Prepare configuration file (for eg: load.yml) as shown in the following example, with your Intercom account access information to:

import Users

in:
  type: intercom 
  access_token: xxxxxxx 
  target: users
  incremental: false
out:
 mode: append

import Conversations

in:
  type: intercom 
  access_token: xxxxxxx 
  target: conversations
  incremental: false
out:
 mode: append


import Segments

in:
  type: intercom 
  access_token: xxxxxxx 
  target: segments
out:
 mode: append

import Tags

in:
  type: intercom
  access_token: xxxxxxx
  target: tags
out:
  mode: append 

Access Token

The preceding example dumps Intercom’s users objects. Here access_token is a valid access token achieved from Intercom. Using the OAuth flow through TD Console is recommended. Your Personal Access Token can be used for access_token instead of the OAuth flow.

Target

You can select which data needs to be fetched from store as target option.


Preview Data (Optional)

You can preview data to be imported using the command td connector:preview.

$ td connector:preview load.yml
+-----------+--------------+----------------------------+----
| id:string | user_id:string | email:string             | ...
+-----------+----------------+-------------------------------
| "1"       | "33"           | "xxxx@xxx.com"           |
| "2"       | "34"           | "yyyy@yyy.com"           |
| "3"       | "35"           | "zzzz@zzz.com"           |
| "4"       | "36"           | "aaaa@aaa.com"           |
| "6"       | "37"           | "bbbb@bbb.com"           |
+-----------+----------------+--------------------------+----


Execute Load Job

Submit the load job. It may take a couple of hours depending on the data size. Users need to specify the database and table where their data are stored.

It is recommended to specify --time-column option, since Treasure Data’s storage is partitioned by time. If the option is not given, the Data Connector will choose the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.

If your data doesn’t have a time column you may add it using add_time filter option. More details at add_time filter plugin

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column created_at

The preceding command assumes you have already created database(td_sample_db) and table(td_sample_table). If the database or the table do not exist in TD this command will not succeed, so create the database and table manually or use --auto-create-table option with td connector:issue command to auto-create the database and table:

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column created_at --auto-create-table


You can assign Time Format column to the "Partitioning Key" by "--time-column" option.


Scheduled Execution

You can schedule a periodic Data Connector execution for periodic Intercom import. We configure our scheduler carefully to ensure high availability. By using this feature, you no longer need a cron daemon on your local data center.


Create the Schedule

A new schedule can be created using the td connector:create command. The name of the schedule, cron-style schedule, the database and table where their data will be stored, and the Data Connector configuration file are required.

$ td connector:create \
    daily_intercom_import \
    "10 0 * * *" \
    td_sample_db \
    td_sample_table \
    load.yml


The `cron` parameter also accepts these three options: `@hourly`, `@daily` and `@monthly`.


By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or --timezone option. The `--timezone` option only supports extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles' etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.


List the Schedules

You can see the list of scheduled entries by td connector:list.

$ td connector:list
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| Name                  | Cron         | Timezone | Delay | Database     | Table           | Config                     |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| daily_intercom_import | 10 0 * * *   | UTC      | 0     | td_sample_db | td_sample_table | {"type"=>"intercom", ... } |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+


Show the Setting and History of Schedules

td connector:show shows the execution setting of a schedule entry.

% td connector:show daily_intercom_import
Name     : daily_intercom_import
Cron     : 10 0 * * *
Timezone : UTC
Delay    : 0
Database : td_sample_db
Table    : td_sample_table

td connector:history shows the execution history of a schedule entry. To investigate the results of each individual execution, use td job <jobid>.

% td connector:history daily_intercom_import
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| JobID  | Status  | Records | Database     | Table           | Priority | Started                   | Duration |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| 578066 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-18 00:10:05 +0000 | 160      |
| 577968 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-17 00:10:07 +0000 | 161      |
| 577914 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-16 00:10:03 +0000 | 152      |
| 577872 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-15 00:10:04 +0000 | 163      |
| 577810 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-14 00:10:04 +0000 | 164      |
| 577766 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-13 00:10:04 +0000 | 155      |
| 577710 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-12 00:10:05 +0000 | 156      |
| 577610 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-11 00:10:04 +0000 | 157      |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
8 rows in set


Delete the Schedule

td connector:delete will remove the schedule.

$ td connector:delete daily_intercom_import


Modes for Out Plugin