{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"Integrations","type":"markdown"},"seo":{"title":"Zendesk Export Integration CLI","description":"Treasure Data Product Documentation · Collect and Unify · Segment and Activate · Experiment and Analyze · Decisioning Automate with AI Scale and Trust.","siteUrl":"https://docs.treasuredata.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"zendesk-export-integration-cli","__idx":0},"children":["Zendesk Export Integration CLI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can export data results from TD to Zendesk Sunshine using CLI (TD Toolbelt)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tools/cli-and-sdks/td-toolbelt"},"children":["TD Toolbelt"]}," is installed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Basic knowledge of Zendesk Sunshine and Zendesk account."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":2},"children":["Limitations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The query must match require columns(name & data type) with target event."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-the-command-line-to-create-your-connection","__idx":3},"children":["Using the Command Line to Create Your Connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the CLI to configure your connection."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configuration keys and descriptions as follows:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Config Key"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["zendesk"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["login_url"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Login URL for Zendesk"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["auth_method"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["basic or token or oauth"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["username"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes if auth_method is basic or token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your Zendesk username"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["password"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes if auth_method is basic"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zendesk password"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes if auth_method is token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zendesk token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["access_token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes if auth_method is oauth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zendesk OAuth access token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["target"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["which export Zendesk target: event_profile, event_profile_id or event_user_id"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["skip_invalid_records"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["no"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["continue when have invalid record"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connection-and-query-examples","__idx":4},"children":["Connection and Query Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a event for profiles"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"td query --database my_db \\\n         --result '{\n            \"type\": \"zendesk\",\n            \"login_url\": \"https://{example}.zendesk.com\",\n            \"auth_method\": \"basic\",\n            \"password\": \"xxxxx\",\n            \"username\": \"xxxxx\",\n            \"target\": \"event_profile\",\n            \"skip_invalid_records\": false\n         }'\n         'SELECT profile_source, profile_type, profile_identifier_1, \n          event_source, event_type, event_properties\n          FROM your_table;'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a event for profile id"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"td query --database my_db \\\n         --result '{\n            \"type\": \"zendesk\",\n            \"login_url\": \"https://{example}.zendesk.com\",\n            \"auth_method\": \"basic\",\n            \"password\": \"xxxxx\",\n            \"username\": \"xxxxx\",\n            \"target\": \"event_profile_id\",\n            \"skip_invalid_records\": false\n         }'\n         'SELECT profile_id, event_source, event_type, event_properties\n          FROM your_table;'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a event for user id"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"td query --database my_db \\\n         --result '{\n            \"type\": \"zendesk\",\n            \"login_url\": \"https://{example}.zendesk.com\",\n            \"auth_method\": \"basic\",\n            \"password\": \"xxxxx\",\n            \"username\": \"xxxxx\",\n            \"target\": \"event_user_id\",\n            \"skip_invalid_records\": false\n         }'\n         'SELECT user_id, profile_source, profile_type, profile_identifier_1, \n          event_source, event_type, event_properties\n          FROM your_table;'\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Zendesk Export Integration CLI","id":"zendesk-export-integration-cli","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Using the Command Line to Create Your Connection","id":"using-the-command-line-to-create-your-connection","depth":2},{"value":"Connection and Query Examples","id":"connection-and-query-examples","depth":3}],"frontmatter":{"seo":{"title":"Zendesk Export Integration CLI"}},"lastModified":"2026-01-09T05:58:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/int/zendesk-export-integration-cli","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}