Skip to main content

Zendesk Chat

This connector captures data from Zendesk into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-zendesk-chat:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system.

Supported data resources

The following data resources are supported through the Zendesk API:

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

  • A Zendesk Account with permission to access data from accounts you want to sync.
  • An Access Token. We recommend creating a restricted, read-only key specifically for Estuary access to allow you to control which resources Estuary should be able to access.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification files. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Zendesk Chat source connector.

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/start_dateStart DateThe date from which you would like to replicate data for Zendesk Support API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.stringRequired
/subdomainSubdomainThis is your Zendesk subdomain that can be found in your account URL.stringRequired

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource in Zendesk from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample

captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-zendesk-chat:dev
config:
credentials:
access_token: <secret>
credentials: access_token
start_date: 2022-03-01T00:00:00Z
subdomain: my_subdomain
bindings:
- resource:
stream: accounts
syncMode: full_refresh
target: ${PREFIX}/accounts