Data Connector for Zendesk

Table of Contents

Prerequisites

  • Basic knowledge of Treasure Data
  • Zendesk account

Step 0: Install ‘td’ command

Install the newest Treasure Data Toolbelt.

Step 1: Create Seed Config File (seed.yml)

First, please prepare seed.yml as below, with your login_url, username (email), token and, target. You’ll use “append” mode:

in:
  type: zendesk
  login_url: https://<YOUR_DOMAIN_NAME>.zendesk.com
  auth_method: token
  username: <YOUR_EMAIL_ADDRESS>
  token: <YOUR_API_TOKEN>
  target: tickets
  start_time: "2007-01-01 00:00:00+0000"
out:
  mode: append

token can be created by Admin Home –> CHANNELS –> API –> "add new token" (https://<YOUR_DOMAIN_NAME>.zendesk.com/agent/admin/api).

target specifies what type of object you want to dump from Zendesk. Currently tickets, ticket_events, users, organizations, ticket_fields and ticket_forms are supported.

For more details on available out modes, see Appendix

Step 2: Guess Fields (Generate load.yml)

Second, please use connector:guess. This command automatically reads the target data, and intelligently guesses the data format.

$ td connector:guess seed.yml -o load.yml

If you open up load.yml, you’ll see guessed file format definitions including, in some cases, file formats, encodings, column names, and types.

in:
  type: zendesk
  login_url: https://<YOUR_DOMAIN_NAME>.zendesk.com
  auth_method: token
  username: <YOUR_EMAIL_ADDRESS>
  token: <YOUR_API_TOKEN>
  target: tickets
  start_time: '2007-01-01 00:00:00+0000'
  columns:
  - {name: allow_channelback, type: boolean}
  - {name: assignee_id, type: string}
  - {name: brand_id, type: long}
  - {name: collaborator_ids, type: json}
  - {name: created_at, type: timestamp, format: "%Y-%m-%dT%H:%M:%S%z"}
  - {name: custom_fields, type: json}
  - {name: description, type: string}
  - {name: due_at, type: string}
  - {name: external_id, type: string}
  - {name: fields, type: json}
  - {name: forum_topic_id, type: string}
  - {name: generated_timestamp, type: long}
  - {name: group_id, type: long}
  - {name: has_incidents, type: boolean}
  - {name: id, type: long}
  - {name: organization_id, type: long}
  - {name: priority, type: string}
  - {name: problem_id, type: string}
  - {name: raw_subject, type: string}
  - {name: recipient, type: string}
  - {name: requester_id, type: string}
  - {name: satisfaction_probability, type: string}
  - {name: satisfaction_rating, type: string}
  - {name: sharing_agreement_ids, type: json}
  - {name: status, type: string}
  - {name: subject, type: string}
  - {name: submitter_id, type: long}
  - {name: tags, type: json}
  - {name: ticket_form_id, type: string}
  - {name: type, type: string}
  - {name: updated_at, type: timestamp, format: "%Y-%m-%dT%H:%M:%S%z"}
  - {name: url, type: string}
  - {name: via, type: json}
filters: []
out: {more: append}
exec: {}

Then you can preview how the system will parse the file by using preview command.

$ td connector:preview load.yml

If the system detects your column name or type unexpectedly, please modify load.yml directly and preview again.

Untitled-3
Currently, the Data Connector supports parsing of "boolean", "long", "double", "string", and "timestamp" types.

Step 3: Execute Load Job

Finally, 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 is stored.

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

The above 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
Untitled-3
You can assign Time Format column to the "Partitioning Key" by "--time-column" option.

Incremental Load

You can load records incrementally from Zendesk by using the incremental flag. If False, the start_time in next.yml would not be updated. That means the connector will always fetch all the data from Zendesk with static conditions. If True, the start_time would be updated in next.yml. The default is True.

in:
  type: zendesk
  login_url: https://<YOUR_DOMAIN_NAME>.zendesk.com
  auth_method: token
  username: <YOUR_EMAIL_ADDRESS>
  token: <YOUR_API_TOKEN>
  target: tickets
  start_time: "2007-01-01 00:00:00+0000"
  incremental: true
out:
  mode: append

Scheduled execution

You can schedule periodic Data Connector execution for periodic Zendesk import. We take great care in distributing and operating our scheduler in order to achieve 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 by 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_zendesk_import \
    "10 0 * * *" \
    td_sample_db \
    td_sample_table \
    load.yml
Untitled-3
The `cron` parameter also accepts three special options: `@hourly`, `@daily` and `@monthly`.
Untitled-3
By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or --timezone option. Please note that `--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 currently scheduled entries by td connector:list.

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

Show the Setting and History of Schedules

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

% td connector:show daily_zendesk_import
Name     : daily_zendesk_import
Cron     : 10 0 * * *
Timezone : UTC
Delay    : 0
Database : td_sample_db
Table    : td_sample_table
Config
---
// Displayed load.yml configuration.

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

% td connector:history daily_zendesk_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_zendesk_import

Appendix

A) Modes for out plugin

You can specify file import mode in out section of seed.yml.

append (default)

This is the default mode and records are appended to the target table.

in:
  ...
out:
  mode: append

replace (In td 0.11.10 and later)

This mode replaces data in the target table. Please note that any manual schema changes made to the target table will remain intact with this mode.

in:
  ...
out:
  mode: replace

B) Include sub resources

You can specify includes option to get related objects.

For example, if you want to get tickets data with comments, you can do it by such config.

in:
  type: zendesk
  target: tickets
  includes:
    - comments
  ...
out:
  mode: replace

Further Information


Last modified: Aug 04 2016 22:32:50 UTC

If this article is incorrect or outdated, or omits critical information, please let us know. For all other issues, please see our support channels.