# Zendesk

tap-zendesk is an extractor that pulls data from a Zendesk REST API and produces JSON-formatted data following the Singer spec.

# Zendesk Setup

In order to access your Zendesk data, you will need:

  • Email
  • API Token
  • Zendesk Subdomain
  • Start Date

# Email

Configuration Notes

  • The Email (e.g., hello@meltano.com) used to sign in to your Zendesk account

This is the email you use to login to your Zendesk dashboard.

# API Token

Configuration Notes

  • The API Token (e.g., oz3M12Xdtlrkj38efLkOzHI9GhkJxrquuw) accessible via your Zendesk account when signed in
  1. Login to your Zendesk dashboard.

Screenshot of sample Zendesk dashboard

  1. On the left navigation, scroll down to the Channels section to click on the API link. If you don't see this, your account does not have adequate permissions.

Screenshot of left nav with API link

  1. Ensure that Token Access is enabled

  2. Click on the + button to create a new API token

Screenshot of new API token creation

  1. Add Meltano as the API Token Description

  2. Copy the API token since it will not be shown again

  3. Click Save button to complete API key creation

Zendesk Subdomain

Configuration Notes

  • The subdomain you access when using Zendesk

# Zendesk Subdomain

Configuration Notes

  • If the URL is meltano.zendesk.com, then the subdomain is meltano.

When visiting your Zendesk instance, the URL is structured as follows:


You'll need this subdomain when configuring the extractor.

For example, if the URL is meltano.zendesk.com, then the subdomain is meltano.

# Start Date

This property determines how much historical data will be extracted.

Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

# Advanced: Command Line Installation

  1. Navigate to your Meltano project in the terminal
  2. Run the following command:
meltano add extractor tap-zendesk

If you are successful, you should see Added and installed extractors 'tap-zendesk' in your terminal.

# Configuration

  1. Open your project's .env file in a text editor
  2. Add the following variables to your file:
export TAP_ZENDESK_EMAIL="yourZendeskEmail"
export TAP_ZENDESK_API_TOKEN="yourZendeskApiToken"
export TAP_ZENDESK_SUBDOMAIN="yourZendeskSubdomain"
# The date uses ISO-8601 and supports time if desired
export TAP_ZENDESK_START_DATE="yourZendeskStartDate"

# Additional Information