Page Comparison

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata.

Admin Email

Yes

Required. Zendesk admin email.

API Token

Yes

Required. Zendesk API token. Can be obtained from the Zendesk Support Admin interface. For API Token generation, see the Zendesk documentation.

Subdomains

Yes

Required. List of Zendesk Subdomains to read object from.

Object to Pull

Yes

Optional. Objects to pull from Zendesk API. If not specified, data is pulled from all objects.

Default is blank.

Object to Skip

No

Optional. Objects to skip from Zendesk API. Default is blank.

Start Date

Yes

Optional.  Filter data to include only records that have Zendesk modified date is greater than or equal to the specified date. The date must be provided in the date format:

Format: Date, time, and time zone offset

Format Syntax: YYYY-MM-DDThh:mm:ss+hh:mm
Example: 1999-01-01T23:01:01+01:00

Format Syntax: YYYY-MM-DDThh:mm:ss-hh:mm
Example: 1999-01-01T23:01:01-08:00

Format Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 1999-01-01T23:01:01Z

Start Date is required for batch objects like: Ticket Comments, Organizations, Ticket Metric Events, Tickets, Users.

End Date

Yes

Optional. Filter data to include only records that have Zendesk modified date is less than the specified date. The date must be provided in the date format:

Format: Date, time, and time zone offset

Format Syntax: YYYY-MM-DDThh:mm:ss+hh:mm
Example: 1999-01-01T23:01:01+01:00

Format Syntax: YYYY-MM-DDThh:mm:ss-hh:mm
Example: 1999-01-01T23:01:01-08:00

Format Syntax: YYYY-MM-DDThh:mm:ssZ
Example: 1999-01-01T23:01:01Z

If you enter an End Date and Start Date, the data is modified within a specific time window. If no value is provided, no upper bound is applied.

Satisfaction Ratings Score

Yes

Filter Satisfaction Ratings object to include only records that have a Zendesk score equal to the specified score. Only applicable for the Satisfaction Rating object.

Default is blank.

Table Field Name

Yes

Optional. The name of the field that holds the table name. Must not be the name of any table column that will be read. 

Default is `tablename`.

Max Retry Count

Yes

Required. Maximum number of retry attempts.

Default is 20.

Connect Timeout

Yes

Required. Maximum time in seconds connection initialization can take.

Default is 300.

Read Timeout

Yes

Required. Maximum time in seconds fetching data from the server can take.

Default is 300.

Use connection (on/off toggle)

No

Whether to use an existing connection.

Connections (browse connections)

Yes

Choose the existing connection to use.