The tap-zendesk-chat extractor pulls data from Zendesk Chat that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-zendesk-chat extractor to your
project using
:meltano add -
Configure the tap-zendesk-chat
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-zendesk-chatmeltano config tap-zendesk-chat set --interactivemeltano config tap-zendesk-chat testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-zendesk-chat
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-zendesk-chat settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-zendesk-chat list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Access Token (access_token)
-
Environment variable:
TAP_ZENDESK_CHAT_ACCESS_TOKEN
The Zendesk Chat access token.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set access_token [value]Agents Page Limit (agents_page_limit)
-
Environment variable:
TAP_ZENDESK_CHAT_AGENTS_PAGE_LIMIT
The page limit of API requests, default 100.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set agents_page_limit [value]Chat Search Interval Days (chat_search_interval_days)
-
Environment variable:
TAP_ZENDESK_CHAT_CHAT_SEARCH_INTERVAL_DAYS
The chat search interval days, default 14 days.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set chat_search_interval_days [value]Chats Full Sync Days (chats_full_sync_days)
-
Environment variable:
TAP_ZENDESK_CHAT_CHATS_FULL_SYNC_DAYS
The amount of days between full syncs of chats. This allows you to configure the tap to re-sync all chats every so many number of days. This exists due to the options (or lack thereof) the Zendesk Chat API provides when syncing chats. Each chat has an "end timestamp" that indicates when the chat was "ended." However, even after the chat has ended, it may be modified. In order to not sync all of the chats during every run of the tap, the tap filters data based on the "end timestamp." But this means if the chat is modified after the tap has already synced it, any modifications will be missed by the tap. By re-syncing every N days, you are able to update any chats that may have changed since they were synced by the tap. Defaults to None, meaning don't full sync regularly.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set chats_full_sync_days [value]Start Date (start_date)
-
Environment variable:
TAP_ZENDESK_CHAT_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.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_ZENDESK_CHAT_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-zendesk-chat set user_agent [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
