Zendesk Chat

tap-zendesk-chat from singer-io

Support ticketing system & customer service platform

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

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-chat extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-zendesk-chat
  3. Configure the tap-zendesk-chat settings using
    meltano config
    :
  4. meltano config tap-zendesk-chat set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-zendesk-chat test

Next steps

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

User Agent (user_agent)

  • Environment variable: TAP_ZENDESK_CHAT_USER_AGENT

The user agent to send with requests.

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.

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.

Access Token (access_token)

  • Environment variable: TAP_ZENDESK_CHAT_ACCESS_TOKEN

The Zendesk Chat access token.

Agents Page Limit (agents_page_limit)

  • Environment variable: TAP_ZENDESK_CHAT_AGENTS_PAGE_LIMIT

The page limit of API requests, default 100.

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.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-zendesk-chat 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.

Install

meltano add extractor tap-zendesk-chat

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api