Skip to main content

Zendesk Support connector reference

This page provides technical reference information for the Zendesk Support connector.

Supported source tables​

The Zendesk Support connector supports ingestion from the following Zendesk APIs.

Ticketing API​

Incremental tables:

  • tickets
  • ticket_audits
  • ticket_comments
  • ticket_metric_events
  • ticket_skips
  • ticket_triggers
  • trigger_categories
  • side_conversation_events
  • users
  • user_identities
  • organizations
  • macros
  • deletion_schedules

Batch tables:

  • account_attributes
  • automations
  • brands
  • brand_agents
  • custom_roles
  • custom_statuses
  • groups
  • group_memberships
  • group_sla_policies
  • locales
  • organization_fields
  • organization_memberships
  • organization_subscriptions
  • schedules
  • sla_policies
  • suspended_tickets
  • tags
  • ticket_activities
  • ticket_fields
  • ticket_forms
  • ticket_metrics
  • user_fields

Help Center API​

Incremental tables:

  • articles
  • article_attachments
  • article_comments
  • article_votes
  • categories
  • sections

Community API​

Incremental tables:

  • posts
  • post_comments
  • post_votes

Batch tables:

  • topics

Audit Log API​

Incremental tables:

  • audit_logs

Connector options​

These options are specified under zendesk_support_options in the pipeline specification.

Option

Type

Required

Default

Description

start_date

string

No

30 days before the current date

Start date in YYYY-MM-DD format for the initial sync of the audit_logs table. Determines the earliest date from which to sync historical audit log data. This option applies only to audit_logs; other tables ignore it.

Option

Type

Required

Default

Description

start_date

string

No

30 days before the current date

Start date in YYYY-MM-DD format for the initial sync of the audit_logs table. Determines the earliest date from which to sync historical audit log data. This option applies only to audit_logs; other tables ignore it.

Data type handling​

Nested and custom fields​

Some fields in the schema might be nested within complex structures, and the inner-level fields can include custom attributes. To ensure compatibility and consistency, such fields are represented as a string data type.

For example, the custom_fields column in the tickets table is an array of custom objects, which can have any number of subfields. This column is ingested as a string type.