Skip to main content
Version: Next

Zendesk

Zendesk source connector

Support Those Engines​

Spark
Flink
SeaTunnel Zeta

Description​

Used to read data from the Zendesk REST API. It authenticates with a Zendesk account email and API token (sent as an HTTP Basic Authorization header) and reads a Zendesk endpoint such as tickets, users, or organizations into SeaTunnel rows.

This connector is built on top of the Http source connector and inherits most of its options. The differences are the required authentication options and the format default.

Key features​

Options​

nametyperequireddefault valuedescription
urlStringYes-The Zendesk REST API endpoint to read from, for example https://your-subdomain.zendesk.com/api/v2/tickets.json.
emailStringYes-The Zendesk account email used for API token authentication. It is combined with api_token as {email}/token:{api_token} and sent as an HTTP Basic Authorization header.
api_tokenStringYes-The Zendesk API token. See the Zendesk API token docs for how to generate one.
methodStringNogetHTTP request method. Only GET and POST are supported.
schemaConfigNo-The structure of the data, including field names and field types. For more details, please refer to Schema Feature.
formatStringNotextThe format of upstream data, only json and text are supported.
paramsMapNo-Query parameters appended to the request URL.
bodyStringNo-Request body sent for POST (or any method that accepts a body). When format = "json", the body must be valid JSON.
json_fieldConfigNo-Maps JSON paths in the response to schema fields. Must be used together with schema. See the Http source connector for details and examples.
content_fieldStringNo-Extracts a sub-section of the JSON response (for example the array under a top-level key such as tickets or users) before mapping to rows. See the Http source connector for details and examples.
poll_interval_millisintNo-Interval in milliseconds between two consecutive requests when running in streaming mode.
retryintNo-Maximum retry times when the HTTP request throws IOException.
retry_backoff_multiplier_msintNo100Retry backoff multiplier in milliseconds.
retry_backoff_max_msintNo10000Maximum retry backoff in milliseconds.
enable_multi_linesbooleanNofalseWhether to parse the response as multiple JSON objects separated by newlines. Only takes effect when format = "json".
common-optionsconfigNo-Source plugin common parameters, please refer to Source Common Options for details.

url [String]​

The Zendesk REST API endpoint to read from, for example https://your-subdomain.zendesk.com/api/v2/tickets.json.

email [String]​

The Zendesk account email used for API token authentication. It is combined with api_token as {email}/token:{api_token} and sent as an HTTP Basic Authorization header.

api_token [String]​

The Zendesk API token. See the Zendesk API token docs for how to generate one.

method [String]​

HTTP request method. Only GET and POST are supported. POST is typically used together with body for paginated or query-driven Zendesk endpoints.

schema [Config]​

The structure of the data, including field names and field types. For more details, please refer to Schema Feature.

format [String]​

The format of upstream data. Only json and text are supported; default is text. Zendesk endpoints always return JSON, so set format = "json" together with content_field to extract the result array before mapping to rows.

params [Map]​

Query parameters appended to the request URL. Use this for Zendesk endpoints that accept filters, pagination, or other query parameters.

body [String]​

Request body sent for POST (or any method that accepts a body). When format = "json", the body must be valid JSON.

json_field [Config]​

This parameter helps you configure the schema, so this parameter must be used with schema. It maps JSON paths in the response to schema fields. See the Http source connector for details and examples.

content_field [String]​

This parameter extracts a sub-section of the JSON response (for example the array under a top-level key such as tickets or users) before mapping to rows. Use content_field = "$.tickets.*" when reading /api/v2/tickets.json, since the ticket rows live under the tickets key. See the Http source connector for details and examples.

poll_interval_millis [int]​

Interval in milliseconds between two consecutive requests when the connector runs in streaming mode. Has no effect in batch mode.

retry [int]​

Maximum retry times when the HTTP request throws IOException. The retry loop uses retry_backoff_multiplier_ms and retry_backoff_max_ms to compute the wait between attempts.

retry_backoff_multiplier_ms [int]​

Base unit (in milliseconds) for the retry backoff. The wait between attempts grows across retries up to retry_backoff_max_ms. The growth curve is not a fixed multiplier per attempt — see HttpClientProvider (connector-http-base) for the exact Fibonacci-based strategy.

retry_backoff_max_ms [int]​

Maximum wait between retries, in milliseconds.

enable_multi_lines [boolean]​

Whether to parse the response as multiple JSON objects separated by newlines. Only takes effect when format = "json".

common options​

Source plugin common parameters, please refer to Source Common Options for details.

Task Example​

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  Zendesk {
    url = "https://your-subdomain.zendesk.com/api/v2/tickets.json"
    email = "agent@example.com"
    api_token = "${ZENDESK_API_TOKEN}"
    method = "GET"
    format = "json"
    content_field = "$.tickets.*"
    schema = {
      fields {
        id = bigint
        subject = string
        status = string
        priority = string
        created_at = string
        updated_at = string
      }
    }
  }
}

sink {
  Console {}
}

Changelog​

Change Log
ChangeCommitVersion