Skip to main content

Zendesk Reader programmer's reference

Zendesk Reader supported objects

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

Object name	Supported modes	Checkpoint field	Supported operations	Scope	Notes
`Activities`	Initial Load	updated_at	Insert	read
`Audit_logs`	Initial Load	created_at	Insert	read
`Automations`	Initial Load	None	Insert	read
`Bookmarks`	Initial Load	created_at	Insert	read
`Brands`	Initial Load	updated_at	Insert	read
`Custom_roles`	Initial Load	updated_at	Insert	read
`Custom_statuses`	Initial Load	updated_at	Insert	read
`Deleted_tickets`		deleted_at		read
`Deleted_users`	Initial Load	updated_at	Insert	read
`Group_memberships`	Initial Load	updated_at	Insert	read
`Groups`	Initial Load	updated_at	Insert / Update	read
`Items`	Initial Load	updated_at	Insert	read
`Locales`	Initial Load	updated_at	Insert	read
`Macros`	Initial Load	updated_at	Insert	read
`Organization_fields`	Initial Load	updated_at	Insert	read
`Organization_memberships`	Initial Load	updated_at	Insert	read
`Organization_subscriptions`	Initial Load	created_at	Insert	read
`Organizations`	All	updated_at	Insert / Update	read
`Recipient_addresses`	Initial Load	updated_at	Insert	read
`Requests`	Initial Load	updated_at	Insert	read
`Resource_collections`	Initial Load	updated_at	Insert	read
`Routing_attribute_definitions`	Initial Load	updated_at	Insert	read
`Satisfaction_ratings`	Initial Load	updated_at	Insert	read
`Satisfaction_reasons`	Initial Load	updated_at	Insert	read	Reading these objects requires you to change some Zendesk settings. See Zendesk help > Support > Using Support ticketing system > Measuring success > Working with satisfaction reasons
`Sessions`	Initial Load	None	Insert	read
`Settings`	Initial Load			read
`Sharing_agreements`	Initial Load	updated_at	Insert	read
`Slas`(SLA policy)	Initial Load	updated_at	Insert	read
`Suspended_tickets`	Initial Load	None	Insert	read
`Tags`	Initial Load	None	Insert	read
`Target_failures`	Initial Load	created_at	Insert	read
`Targets`	Initial Load	created_at	Insert	read
`Ticket_audits`	Initial Load	created_at	Insert	read
`Ticket_events`	Incremental	time	Insert	read
`Ticket_fields`	Initial Load	updated_at	Insert	read
`Ticket_forms`	Initial Load	updated_at	Insert	read
`Ticket_metric_events`	Incremental	time	Insert	read
`Ticket_metrics`	Initial Load	updated_at	Insert	read
`Tickets`	All	updated_at	Insert / Update	read
`Triggers`	Initial Load	updated_at	Insert	read
`User_fields`	Initial Load	updated_at	Insert	read
`Users`	All	updated_at	Insert / Update	read
`Workspaces`	Initial load	None	Insert	read

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	1000	The size of each batch to fetch. Cannot exceed 1000.
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 the default value of `InitialLoad` to read all existing data, then stop. Set the value to `IncrementalLoad` to read all new data continuously.
Objects	Text Box		A semicolon-delimited (`;`) list of objects to read from the Zendesk instance. Supports the `%` wildcard during intial load. 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	Specifies an interval as an integer followed by a unit. Supported units are days (`d`), hours (`h`), minutes (`m`), or seconds (`s`). The Zendesk reader polls the Zendesk instance at the specified interval.
Start Timestamp	Text Box		Specifies a time from which the adapter beings sync operations. Timestamps use UTC in the ISO 8601 format, such as 2024-01-31T01:42:33Z. When no timestamp is available, the Striim Zendesk reader syncs from 60 seconds prior to the current timestamp for incremental load.
Thread pool count	Integer	1	Specifies the number of execution threads to use. Best performance uses one execution thread for each table being synced. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.
Use connection profile	Toggle	false
Username	Text Box		The email ID of a Zendesk user account.

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