The tap-zendesk Meltano extractor pulls data from Zendesk that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-zendesk are available. This document describes the default twilio-labs variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-zendesk extractor to your project using meltano add :

    meltano add extractor tap-zendesk
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-zendesk requires the configuration of one of the following groups of settings:

The settings for extractor tap-zendesk that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Email (email) #

This is the email you use to login to your Zendesk dashboard. For API Authentication, /token is automatically appended to the email address and is not required in the configuration.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-zendesk set email <email>

export TAP_ZENDESK_EMAIL=<email>

API Token (api_token) #

How to get #

  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

See https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-zendesk set api_token <api_token>

export TAP_ZENDESK_API_TOKEN=<api_token>

Access Token (access_token) #

To use OAuth, you will need to fetch an access_token from a configured Zendesk integration.

See https://support.zendesk.com/hc/en-us/articles/203663836.

See https://support.zendesk.com/hc/en-us/articles/203663836.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-zendesk set access_token <access_token>

export TAP_ZENDESK_ACCESS_TOKEN=<access_token>

Zendesk Subdomain (subdomain) #

When visiting your Zendesk instance, the URL is structured as follows: SUBDOMAIN.zendesk.com.

You’ll need this subdomain when configuring the extractor.

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

See https://support.zendesk.com/hc/en-us/articles/221682747-Where-can-I-find-my-Zendesk-subdomain-.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-zendesk set subdomain <subdomain>

export TAP_ZENDESK_SUBDOMAIN=<subdomain>

Start Date (start_date) #

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.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-zendesk set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_ZENDESK_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help? #

If you're having trouble getting the tap-zendesk extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!