Zendesk Import 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

Treasure Data allows you to directly importing data from your organization’s Zendesk account.

Prerequisites

• Basic knowledge of Treasure Data
• Zendesk account
• Zendesk Zopim account to retrieve Chat data

Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/

Import from Zendesk via TD Console

Create a New Authentication

1. Open the TD Console.

2. Navigate to Integrations Hub > Catalog.

3. Search and select Zendesk.

   

4. Click Create. You are creating an authenticated connection. The following dialog opens.

   

5. There are three options for Auth method: basic, token, oauth.

   1. To import chat data, enter in this url for Login Url for Zendesk: https://www.zopim.com. Token authentication with Chat is not supported.

6. Fill in all the required fields, then click Continue.

7. Name your new Zendesk connection. Click Done.
   

Transfer Your Data to Treasure Data

After creating the authenticated connection, you are automatically taken to the Authentications tab.

1. Search for the connection you created and click New Source.

2. Edit the appropriate fields.

   

Source Preview

1. Preview your data. To make changes, click Advanced Settings.

   

2. Select Next.

Advanced Settings

1. After selecting Advanced Settings, the following dialog opens.

   

2. Edit the parameters. Select Save and Next.

Data Placement

For data placement, select the target database and table where you want your data placed and indicate how often the import should run.

1. Select Next. Under Storage, you will create a new or select an existing database and create a new or select an existing table for where you want to place the imported data.

2. Select a Database > Select an existing or Create New Database.

3. Optionally, type a database name.

4. Select a Table> Select an existing or Create New Table.

5. Optionally, type a table name.

6. Choose the method for importing the data.

   • Append (default)-Data import results are appended to the table. If the table does not exist, it will be created.
   • Always Replace-Replaces the entire content of an existing table with the result output of the query. If the table does not exist, a new table is created.
   • Replace on New Data-Only replace the entire content of an existing table with the result output when there is new data.

7. Select the Timestamp-based Partition Key column. If you want to set a different partition key seed than the default key, you can specify the long or timestamp column as the partitioning time. As a default time column, it uses upload_time with the add_time filter.

8. Select the Timezone for your data storage.

9. Under Schedule, you can choose when and how often you want to run this query.

Run once

1. Select Off.
2. Select Scheduling Timezone.
3. Select Create & Run Now.

Repeat Regularly

1. Select On.
2. Select the Schedule. The UI provides these four options: @hourly, @daily and @monthly or custom cron.
3. You can also select Delay Transfer and add a delay of execution time.
4. Select Scheduling Timezone.
5. Select Create & Run Now.

After your transfer has run, you can see the results of your transfer in Data Workbench > Databases.

Import from Zendesk via Workflow

For sample workflows on importing data from Zendesk, view Treasure Boxes.

Import from Zendesk via CLI

Install ‘td’ Command

Install the newest TD Toolbelt.

Create Seed Config File (seed.yml)

Prepare seed.yml as shown in the following example, with your login_url, username (email), token and, target. In this example, you 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"
  enable_cursor_based_api: true
out:
  mode: append

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

target specifies the type of object that you want to dump from Zendesk. tickets, ticket_events, ticket_forms, ticket_fields, users, organizations, scores, recipients, object_records, relationship_records and user_events are supported.

For more details on available out modes, see Appendix.

Guess Fields (Generate load.yml)

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 the load.yml file, you 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: '2019-05-15T00:00:00+00:00' 
  columns: 
   - {name: url, type: string} 
   - {name: id, type: long} 
   - {name: external_id, type: string} 
   - {name: via, type: json} 
   - {name: created_at, type: timestamp, format: "%Y-%m-%dT%H:%M:%S%z"} 
   - {name: updated_at, type: timestamp, format: "%Y-%m-%dT%H:%M:%S%z"} 
   - {name: type, type: string} 
   - {name: subject, type: string} 
   - {name: raw_subject, type: string} 
   - {name: description, type: string} 
   - {name: priority, type: string} 
   - {name: status, type: string} 
   - {name: recipient, type: string} 
   - {name: requester_id, type: string} 
   - {name: submitter_id, type: string} 
   - {name: assignee_id, type: string} 
   - {name: organization_id, type: string} 
   - {name: group_id, type: string} 
   - {name: collaborator_ids, type: json} 
   - {name: follower_ids, type: json} 
   - {name: email_cc_ids, type: json} 
   - {name: forum_topic_id, type: string} 
   - {name: problem_id, type: string} 
   - {name: has_incidents, type: boolean} 
   - {name: is_public, type: boolean} 
   - {name: due_at, type: string} 
   - {name: tags, type: json} 
   - {name: custom_fields, type: json} 
   - {name: satisfaction_rating, type: json} 
   - {name: sharing_agreement_ids, type: json} 
   - {name: fields, type: json} 
   - {name: followup_ids, type: json} 
   - {name: ticket_form_id, type: string} 
   - {name: brand_id, type: string} 
   - {name: satisfaction_probability, type: string} 
   - {name: allow_channelback, type: boolean} 
   - {name: allow_attachments, type: boolean} 
   - {name: generated_timestamp, type: long}
out: 
   {mode: append}
exec: {}
filters: 
   type: add_time
   from_value: 
     {mode: upload_time}  
     to_column: {name: time}  

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

$ td connector:preview load.yml

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

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

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

The preceding command assumes that 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 automatically 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

Incremental Load

You can load records incrementally from Zendesk by using the incremental flag. If False, the start_time and end_time in next.yml is not updated. The connector will always fetch all the data from Zendesk with static conditions. If True, the start_time and end_time is 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"  end_time: "2008-01-01 00:00:00+0000" 
  incremental: true
out:
  mode: append

Paginate through lists using cursor pagination

Zendesk supports pagination endpoint that enables you to fetch more than 100,000 records. This endpoint only applies for users and tickets target. For details, see Introducing Pagination Changes - Zendesk API

To use the new endpoint, enable Enable cursor-based API.

Further Information

• List of Options for Zendesk Data Connector