Skip to main content
Version: Next

Zendesk

Zendesk source connector

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.

Key features​

Options​

nametyperequireddefault value
urlStringYes-
emailStringYes-
api_tokenStringYes-
methodStringNoget
schemaConfigNo-
formatStringNotext
paramsMapNo-
bodyStringNo-
json_fieldConfigNo-
content_fieldStringNo-
poll_interval_millisintNo-
retryintNo-
retry_backoff_multiplier_msintNo100
retry_backoff_max_msintNo10000
enable_multi_linesbooleanNofalse
common-optionsconfigNo-

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 supports GET, POST method.

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, now only support json text, default text.

params [Map]​

http params

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

common options​

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

Example​

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

Changelog​

Change Log
ChangeCommitVersion