Skip to main content

Programmers reference for Zendesk Reader

In TQL, specify the reader by its fully qualified name. To use this reader, set Global.ZendeskReader when creating a source, then configure its properties as needed.

Zendesk Reader properties

Property	Type	Default value	Notes
Access token	Password		Provide an externally generated OAuth token. Only used when the Auth Flow property toggle is on.
Auth Flow	Toggle	enabled	When the toggle is on, authentication uses an access token. Otherwise, authentication uses a username and password.
Connection profile name	Dropdown		When `Use connection profile` is toggled, you can select an existing connection profile from the dropdown or create a new one.
Connection retries	Text Box	3	Specifies the maximum number of connection attempts.
Connection timeout	Text Box	30s	Specifies a socket connection timeout in seconds. Cannot exceed 300 seconds.
Connection URL	Text Box		URL of the Zendesk endpoint.
Excluded objects	Text Box		A list of objects excluded from read operations. Typically used to create a list of exceptions when the Objects property includes wildcards. Must be entirely in lowercase.
Fetch size	Integer	100	The size of each batch to fetch. Maximum is 100.
MaxConnections	Text Box	40	Maximum number of connections for the HTTP client pool.
Migrate schema	Toggle	disabled	When enabled, propagates object schema from the source to the target.
Mode	Dropdown Initial load Incremental load Automated mode	Initial load	Controls the basic behavior of the adapter. Use `InitialLoad` to read all existing data, then stop. Use `IncrementalLoad` to read new data continuously.
Objects	Text Box		A semicolon-delimited (`;`) list of objects to read from the Zendesk instance. Values must be entirely in lowercase. Supports the `%` wildcard during Initial load only. Do not modify this property when recovery is enabled for the application.
Password	Password		Password for the Zendesk account specified by the username.
Polling interval	Text Box	120s	Specify an integer followed by a unit: days (`d`), hours (`h`), minutes (`m`), or seconds (`s`). The reader polls the Zendesk instance at the specified interval.
Start Timestamp	Text Box		Specifies a time from which the adapter begins sync operations. Timestamps use UTC in the ISO 8601 format, for example `2024-01-31T01:42:33Z`. When no timestamp is provided for incremental load, the reader syncs from 60 seconds prior to the current time.
Thread pool count	Integer	0	Specifies the number of execution threads to use. Best performance typically uses one thread per object being synced. Ensure the connection pool size is greater than or equal to the number of execution threads to avoid halts during large ingestions. The `ThreadPoolCount` value must be less than the number of available processors. For example, if the system has eight processors, set `ThreadPoolCount` to 7 or lower.
Use connection profile	Toggle	false	When enabled, uses a saved connection profile rather than individual properties.
Username	Text Box		The email ID of a Zendesk user account.

Zendesk Reader supported objects

Zendesk Reader supports the following objects. Custom objects are not supported.

Dependency note: some secondary objects depend on related primary objects. For example, comments- or metrics-oriented objects may require that the corresponding primary ticket or user objects are also selected. If a secondary object is selected without its primary, reads may return empty results.

Datatype support

Striim type	Example Zendesk data	Notes
String	Names, emails, IDs represented as strings, JSON text	Default mapping for textual fields and JSON blobs not expanded into columns.
Long	Integer identifiers, counters	Whole-number fields.
Double	Durations, numeric metrics	Floating-point fields.
boolean	Flags such as `active`, `verified`	True/false fields.
org.joda.time.DateTime	`created_at`, `updated_at`	Timestamp fields in ISO 8601 UTC.
java.lang.Object	Nested structures, arrays	Used when a field is heterogeneous or complex; may be serialized as JSON.

Would you like to provide feedback? Just click here to suggest edits.