Zendesk Support

Zendesk Support provides SaaS products related to customer support, sales, and other customer communications. You can use Zendesk Support as a data source when landing or replicating data.

Zendesk Support integration replicates data using the Zendesk Support API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To set up the integration, you must have administrator permissions in Zendesk. Replicating SLA policies requires an Enterprise or Professional plan.

Creating the connection

For more information, see Connecting to SaaS applications.

Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify.
Tip noteYou may need to scroll down to see this field.
When status is Verified, the authentication is verified.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Zendesk Subdomain	You can find the subdomain of your Zendesk site in the URL of your account homepage. If the URL is https://qlik.zendesk.com/, the subdomain is qlik.
Client ID	Client ID.
Client Secret	Client secret.
Marketplace Name	Name of the integration.
Marketplace Organization ID	Organization ID.
Marketplace App ID	App ID.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

group_memberships

The group_memberships table contains info about the groups your Zendesk Support agents are members of.

Note: Retrieving group membership data requires Zendesk Support Agent or Admin permissions.

Deleted group memberships

As Zendesk Support’s API doesn’t currently provide a method for identifying deleted group memberships, we recommend periodically dropping this table and allowing Stitch to re-create it. Currently, dropping and re-populating the table is the only way to detect deletions.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join group_memberships with	on
groups	group_memberships.group_id = groups.id
organizations	group_memberships.group_id = organizations.group_id
satisfaction_ratings	group_memberships.group_id = satisfaction_ratings.group_id
tickets	group_memberships.group_id = tickets.group_id
users	group_memberships.group_id = users.default_group_id

created_at

DATE-TIME

default

BOOLEAN

group_id

INTEGER

updated_at

DATE-TIME

url

STRING

user_id

INTEGER

groups

The groups table contains info about the groups in your Zendesk Support account.

Note: Retrieving group data requires Zendesk Support Admin or Agent permissions.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join groups with	on
group_memberships	groups.id = group_memberships.group_id
organizations	groups.id = organizations.group_id
satisfaction_ratings	groups.id = satisfaction_ratings.group_id
tickets	groups.id = tickets.group_id
users	groups.id = users.default_group_id groups.id = users.id
macros	groups.id = macros.restriction.id

created_at

DATE-TIME

deleted

BOOLEAN

INTEGER

name

STRING

updated_at

DATE-TIME

url

STRING

macros

The macros table contains info about the macros in your Zendesk Support account. Macros are actions defined by you that modify the values of a ticket’s fields.

Note: Retrieving macro data requires Zendesk Support Agent or Admin permissions.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join macros with	on
ticket_audits	macros.id = ticket_audits.events.macro_id
groups	macros.restriction.id = groups.id
users	macros.restriction.id = users.id

actions

ARRAY

This is a nested data structure:

field: STRING
value: STRING

active

BOOLEAN

created_at

DATE-TIME

description

STRING

INTEGER

position

INTEGER

restriction

OBJECT

This is a nested data structure:

id: INTEGER
ids: ARRAY, which is also a nested data structure.
type: STRING

title

STRING

updated_at

DATE-TIME

url

STRING

organizations

The organizations table contains information about the organizations your end-users belong to.

Custom organization fields

Zendesk Support integration will replicate any custom fields associated with organization records.

Note: Replicating organization custom fields requires that you be on a Team, Professional, or Enterprise Zendesk Support plan and have Admin permissions in Zendesk Support.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join organizations with	on
groups	organizations.group_id = groups.id
group_memberships	organizations.group_id = group_memberships.group_id
satisfaction_ratings	organizations.group_id = satisfaction_ratings.group_id
tickets	organizations.group_id = tickets.group_id organizations.id = tickets.organization_id organizations.tags = tickets.tags
users	organizations.group_id = users.default_group_id organizations.id = users.organization_id organizations.tags = users.tags
tags	organizations.tags = tags.name

created_at

DATE-TIME

deleted_at

DATE-TIME

details

STRING

domain_names

ARRAY

This is a nested data structure.

external_id

STRING

group_id

INTEGER

name

STRING

notes

STRING

organization_fields

OBJECT

This is a nested data structure.

shared_comments

BOOLEAN

shared_tickets

BOOLEAN

tags

ARRAY

This is a nested data structure.

updated_at

DATE-TIME

url

STRING

satisfaction_ratings

The satisfaction_ratings table contains info about ratings users have offered on support tickets.

Note: This table is only available if satisfaction ratings are enabled in your Zendesk Support account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join satisfaction_ratings with	on
groups	satisfaction_ratings.group_id = groups.id
group_memberships	satisfaction_ratings.group_id = group_memberships.group_id
organizations	satisfaction_ratings.group_id = organizations.group_id
tickets	satisfaction_ratings.group_id = tickets.group_id satisfaction_ratings.ticket_id = tickets.id satisfaction_ratings.assignee_id = tickets.requester_id satisfaction_ratings.requester_id = tickets.requester_id satisfaction_ratings.assignee_id = tickets.follower_ids satisfaction_ratings.requester_id = tickets.follower_ids satisfaction_ratings.assignee_id = tickets.submitter_id satisfaction_ratings.requester_id = tickets.submitter_id satisfaction_ratings.assignee_id = tickets.collaborator_ids satisfaction_ratings.requester_id = tickets.collaborator_ids satisfaction_ratings.assignee_id = tickets.assignee_id satisfaction_ratings.requester_id = tickets.assignee_id
users	satisfaction_ratings.group_id = users.default_group_id satisfaction_ratings.assignee_id = users.id satisfaction_ratings.requester_id = users.id
ticket_audits	satisfaction_ratings.ticket_id = ticket_audits.ticket_id satisfaction_ratings.assignee_id = ticket_audits.author_id satisfaction_ratings.requester_id = ticket_audits.author_id
ticket_comments	satisfaction_ratings.ticket_id = ticket_comments.ticket_id satisfaction_ratings.assignee_id = ticket_comments.author_id satisfaction_ratings.requester_id = ticket_comments.author_id
ticket_metrics	satisfaction_ratings.ticket_id = ticket_metrics.ticket_id

assignee_id

INTEGER

comment

STRING

created_at

DATE-TIME

group_id

INTEGER

reason

STRING

reason_id

INTEGER

requester_id

INTEGER

score

STRING

ticket_id

INTEGER

updated_at

DATE-TIME

url

STRING

sla_policies

The sla_policies table contains info about the Service Level Agreements (SLAs) in your Zendesk Support account. An SLA is a documented agreement between a support provider and their customers that defines performance measures for support.

Note: Replicating SLA policies requires that you be on an Enterprise or Professional Zendesk Support plan, and have Admin permissions in Zendesk Support.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Support documentation

Zendesk Support API method

created_at

DATE-TIME

description

STRING

filter

OBJECT

This is a nested data structure:

all: ARRAY, which is also a nested data structure.
- field: STRING
- operator: STRING
- value: STRING
any: ARRAY, which is also a nested data structure.
- field: STRING
- operator: STRING
- value: STRING

INTEGER

policy_metrics

ARRAY

This is a nested data structure:

business_hours: BOOLEAN
priority: STRING
target: INTEGER

position

INTEGER

title

STRING

updated_at

DATE-TIME

url

STRING

Join tags with	on
organizations	tags.name = organizations.tags
tickets	tags.name = tickets.tags
users	tags.name = users.tags

talk_phone_numbers

This table contains data about phone numbers in Zendesk Talk.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Support API method

capabilities

OBJECT

This is a nested data structure:

mms: BOOLEAN
sms: BOOLEAN
voice: BOOLEAN

categorised_greetings

OBJECT

This is a nested data structure.

categorised_greetings_with_sub_settings

OBJECT

This is a nested data structure.

country_code

STRING

created_at

DATE-TIME

default_greeting_ids

ARRAY

This is a nested data structure.

default_group_id

INTEGER

display_number

STRING

external

BOOLEAN

greeting_ids

ARRAY

This is a nested data structure.

group_ids

ARRAY

This is a nested data structure.

INTEGER

ivr_id

INTEGER

line_type

STRING

location

STRING

name

STRING

nickname

STRING

number

STRING

outbound_enabled

BOOLEAN

priority

INTEGER

recorded

BOOLEAN

schedule_id

INTEGER

sms_enabled

BOOLEAN

sms_group_id

INTEGER

token

STRING

toll_free

BOOLEAN

transcription

BOOLEAN

voice_enabled

BOOLEAN

ticket_audits

The ticket_audits table contains info about the activity associated with a ticket. An audit is a history of all updates to a given ticket. When a ticket is updated in Zendesk Support, an audit record is created. Each audit represents a single update to a ticket.

A single audit record may include multiple event types. For example: A ticket comment, satisfaction rating, and a change event. For a full list of Zendesk Support audit event types, refer to Zendesk Support’s documentation.

Replication

This table uses Append-Only Incremental Replication. This means that new audit records, or updates made to existing audits, are appended as new rows to the end of the table.

Replication Method	Append-Only Incremental
Primary Key	id
Replication Key	created_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join ticket_audits with	on
macros	ticket_audits.events.macro_id = macros.id
ticket_comments	ticket_audits.id = ticket_comments.audit_id ticket_audits.events.audit_id = ticket_comments.audit_id ticket_audits.ticket_id = ticket_comments.ticket_id ticket_audits.author_id = ticket_comments.author_id
satisfaction_ratings	ticket_audits.ticket_id = satisfaction_ratings.ticket_id ticket_audits.author_id = satisfaction_ratings.assignee_id ticket_audits.author_id = satisfaction_ratings.requester_id
tickets	ticket_audits.ticket_id = tickets.id ticket_audits.author_id = tickets.requester_id ticket_audits.author_id = tickets.follower_ids ticket_audits.author_id = tickets.submitter_id ticket_audits.author_id = tickets.collaborator_ids ticket_audits.author_id = tickets.assignee_id
ticket_metrics	ticket_audits.ticket_id = ticket_metrics.ticket_id
users	ticket_audits.author_id = users.id

author_id

INTEGER

created_at

DATE-TIME

events

ARRAY

This is a nested data structure:

attachments: ARRAY, which is also a nested data structure.
audit_id: INTEGER
author_id: INTEGER
body: STRING
created_at: DATE-TIME
data: OBJECT, which is also a nested data structure.
- answered_by_id: INTEGER
- answered_by_name: STRING
- call_duration: STRING
- from: STRING
- recording_url: STRING
- started_at: DATE-TIME
- to: STRING
- transcription_status: STRING
- transcription_text: STRING
field_name: STRING
formatted_from: STRING
formatted_to: STRING
html_body: STRING
id: INTEGER
macro_deleted: BOOLEAN
macro_id: STRING
macro_title: STRING
plain_body: STRING
previous_value: ARRAY, STRING, which is also a nested data structure.
public: BOOLEAN
recipients: ARRAY, which is also a nested data structure.
resource: STRING
subject: STRING
trusted: BOOLEAN
type: STRING
value: ARRAY, STRING, which is also a nested data structure.
via: OBJECT, which is also a nested data structure.
- channel: STRING
- source: OBJECT, which is also a nested data structure.
  - from: OBJECT, which is also a nested data structure.
    - address: STRING
    - deleted: BOOLEAN
    - id: INTEGER
    - name: STRING
    - original_recipients: ARRAY, which is also a nested data structure.
    - revision_id: INTEGER
    - subject: STRING
    - ticket_id: INTEGER
    - title: STRING
  - rel: STRING
  - to: OBJECT, which is also a nested data structure.
    - address: STRING
    - name: STRING

INTEGER

metadata

OBJECT

This is a nested data structure:

flags: ARRAY, which is also a nested data structure.
flags_options: OBJECT, which is also a nested data structure.
- 11: OBJECT, which is also a nested data structure.
  - message: OBJECT, which is also a nested data structure.
    - user: STRING
  - trusted: BOOLEAN
- 2: OBJECT, which is also a nested data structure.
  - trusted: BOOLEAN
notifications_suppressed_for: ARRAY, which is also a nested data structure.
system: OBJECT, which is also a nested data structure.
- client: STRING
- ip_address: STRING
- json_email_identifier: STRING
- latitude: NUMBER
- location: STRING
- longitude: NUMBER
- message_id: STRING
- raw_email_identifier: STRING
trusted: BOOLEAN

ticket_id

INTEGER

via

OBJECT

This is a nested data structure:

channel: STRING
source: OBJECT, which is also a nested data structure.
- from: OBJECT, which is also a nested data structure.
  - address: STRING
  - deleted: BOOLEAN
  - id: INTEGER
  - name: STRING
  - original_recipients: ARRAY, which is also a nested data structure.
  - subject: STRING
  - ticket_id: INTEGER
  - ticket_ids: ARRAY, which is also a nested data structure.
  - title: STRING
- rel: STRING
- to: OBJECT, which is also a nested data structure.
  - address: STRING
  - name: STRING

ticket_comments

The ticket_comments table contains info about the comments on tickets, which is the conversation between requesters, collaborators, and agents. Comments can be public or private.

Replication Method	CDC
Primary Key	id
Replication Key	created_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join ticket_comments with	on
ticket_audits	ticket_comments.audit_id = ticket_audits.id ticket_comments.audit_id = ticket_audits.events.audit_id ticket_comments.ticket_id = ticket_audits.ticket_id ticket_comments.author_id = ticket_audits.author_id
satisfaction_ratings	ticket_comments.ticket_id = satisfaction_ratings.ticket_id ticket_comments.author_id = satisfaction_ratings.assignee_id ticket_comments.author_id = satisfaction_ratings.requester_id
tickets	ticket_comments.ticket_id = tickets.id ticket_comments.author_id = tickets.requester_id ticket_comments.author_id = tickets.follower_ids ticket_comments.author_id = tickets.submitter_id ticket_comments.author_id = tickets.collaborator_ids ticket_comments.author_id = tickets.assignee_id
ticket_metrics	ticket_comments.ticket_id = ticket_metrics.ticket_id
users	ticket_comments.author_id = users.id

attachments

ARRAY

This is a nested data structure.

audit_id

INTEGER

author_id

INTEGER

body

STRING

created_at

DATE-TIME

html_body

STRING

INTEGER

metadata

OBJECT

This is a nested data structure:

flags: ARRAY, which is also a nested data structure.
flags_options: OBJECT, which is also a nested data structure.
- 11: OBJECT, which is also a nested data structure.
  - message: OBJECT, which is also a nested data structure.
    - user: STRING
  - trusted: BOOLEAN
- 2: OBJECT, which is also a nested data structure.
  - trusted: BOOLEAN
notifications_suppressed_for: ARRAY, which is also a nested data structure.
system: OBJECT, which is also a nested data structure.
- client: STRING
- ip_address: STRING
- json_email_identifier: STRING
- latitude: NUMBER
- location: STRING
- longitude: NUMBER
- message_id: STRING
- raw_email_identifier: STRING
trusted: BOOLEAN

plain_body

STRING

public

BOOLEAN

ticket_id

INTEGER

type

STRING

via

OBJECT

This is a nested data structure:

channel: STRING
source: OBJECT, which is also a nested data structure.
- from: OBJECT, which is also a nested data structure.
  - address: STRING
  - deleted: BOOLEAN
  - id: INTEGER
  - name: STRING
  - original_recipients: ARRAY, which is also a nested data structure.
  - subject: STRING
  - ticket_id: INTEGER
  - ticket_ids: ARRAY, which is also a nested data structure.
  - title: STRING
- rel: STRING
- to: OBJECT, which is also a nested data structure.
  - address: STRING
  - name: STRING

ticket_fields

The ticket_fields table contains info about the basic text and custom ticket fields in your Zendesk Support account.

Note: Retrieving ticket metric data requires Zendesk Support Agent or Admin permissions.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join ticket_fields with	on
ticket_forms	ticket_fields.id = ticket_forms.ticket_field_ids
tickets	ticket_fields.id = tickets.custom_fields.id

active

BOOLEAN

agent_description

STRING

collapsed_for_agents

BOOLEAN

created_at

DATE-TIME

custom_field_options

ARRAY

This is a nested data structure:

default: BOOLEAN
id: INTEGER
name: STRING
raw_name: STRING
value: STRING

description

STRING

editable_in_portal

BOOLEAN

INTEGER

position

INTEGER

raw_description

STRING

raw_title

STRING

raw_title_in_portal

STRING

regexp_for_validation

STRING

removable

BOOLEAN

required

BOOLEAN

required_in_portal

BOOLEAN

sub_type_id

INTEGER

system_field_options

ARRAY

This is a nested data structure.

tag

STRING

title

STRING

title_in_portal

STRING

type

STRING

updated_at

DATE-TIME

url

STRING

visible_in_portal

BOOLEAN

ticket_forms

The ticket_forms table contains info about the ticket forms in your Zendesk Support account.

Note: Replicating ticket forms requires that you be on an Enterprise Zendesk Support plan or a Professional plan with the corresponding add-on, and have Admin permissions in Zendesk Support.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join ticket_forms with	on
ticket_fields	ticket_forms.ticket_field_ids = ticket_fields.id
tickets	ticket_forms.ticket_field_ids = tickets.custom_fields.id ticket_forms.id = tickets.ticket_form_id

Join ticket_forms with

ticket_fields

ticket_forms.ticket_field_ids = ticket_fields.id

tickets

ticket_forms.ticket_field_ids = tickets.custom_fields.id

ticket_forms.id = tickets.ticket_form_id

active

BOOLEAN

created_at

DATE-TIME

default

BOOLEAN

display_name

STRING

end_user_visible

BOOLEAN

INTEGER

in_all_brands

BOOLEAN

name

STRING

position

INTEGER

raw_display_name

STRING

raw_name

STRING

restricted_brand_ids

ARRAY

This is a nested data structure.

ticket_field_ids

ARRAY

This is a nested data structure.

updated_at

DATE-TIME

url

STRING

ticket_metric_events

This table contains data about reply times, agent work times, and requester wait times.

Replication Method	CDC
Primary Key	id
Replication Key	time
Useful links	Zendesk Support API method

deleted

BOOLEAN

INTEGER

instance_id

INTEGER

metric

STRING

sla

OBJECT

This is a nested data structure:

business_hours: BOOLEAN
policy: OBJECT, which is also a nested data structure.
- description: STRING
- id: INTEGER
- title: STRING
target: INTEGER

status

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

ticket_id

INTEGER

time

DATE-TIME

type

STRING

ticket_metrics

The ticket_metrics table contains info about the metrics associated with Zendesk Support tickets. This table will not include records for deleted tickets.

Note: Retrieving ticket metric data requires Zendesk Support Admin permissions.

Deleted ticket metrics

As Zendesk Support’s API doesn’t currently support returning metrics for deleted tickets, this table will not contain any metrics for deleted tickets.

If you believe you’re missing records, check in your Zendesk Support account to see if the missing records are for deleted tickets.

For more info on how Zendesk Support handles deleting tickets, refer to their documentation.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join ticket_metrics with	on
satisfaction_ratings	ticket_metrics.ticket_id = satisfaction_ratings.ticket_id
tickets	ticket_metrics.ticket_id = tickets.id
ticket_audits	ticket_metrics.ticket_id = ticket_audits.ticket_id
ticket_comments	ticket_metrics.ticket_id = ticket_comments.ticket_id

agent_wait_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

assigned_at

DATE-TIME

assignee_stations

INTEGER

assignee_updated_at

DATE-TIME

created_at

DATE-TIME

first_resolution_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

full_resolution_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

group_stations

INTEGER

initially_assigned_at

DATE-TIME

instance_id

INTEGER

latest_comment_added_at

DATE-TIME

metric

STRING

on_hold_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

reopens

INTEGER

replies

INTEGER

reply_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

requester_updated_at

DATE-TIME

requester_wait_time_in_minutes

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

solved_at

DATE-TIME

status

OBJECT

This is a nested data structure:

business: INTEGER
calendar: INTEGER

status_updated_at

DATE-TIME

ticket_id

INTEGER

time

STRING

type

STRING

updated_at

DATE-TIME

url

STRING

tickets

The tickets table contains info about the tickets in your Zendesk Support account. Tickets are the means through which your end users (customers) communicate with your Zendesk Support agents.

Note: Retrieving ticket data requires Zendesk Support Admin permissions.

Custom ticket fields

Zendesk Support integration will replicate all custom ticket fields.

Replication Method	CDC
Primary Key	id
Replication Key	generated_timestamp
Useful links	Zendesk Support documentation Zendesk Support API method

Join tickets with	on
groups	tickets.group_id = groups.id
group_memberships	tickets.group_id = group_memberships.group_id
organizations	tickets.group_id = organizations.group_id tickets.organization_id = organizations.id tickets.tags = organizations.tags
satisfaction_ratings	tickets.group_id = satisfaction_ratings.group_id tickets.id = satisfaction_ratings.ticket_id tickets.requester_id = satisfaction_ratings.assignee_id tickets.follower_ids = satisfaction_ratings.assignee_id tickets.submitter_id = satisfaction_ratings.assignee_id tickets.collaborator_ids = satisfaction_ratings.assignee_id tickets.assignee_id = satisfaction_ratings.assignee_id tickets.requester_id = satisfaction_ratings.requester_id tickets.follower_ids = satisfaction_ratings.requester_id tickets.submitter_id = satisfaction_ratings.requester_id tickets.collaborator_ids = satisfaction_ratings.requester_id tickets.assignee_id = satisfaction_ratings.requester_id
users	tickets.group_id = users.default_group_id tickets.organization_id = users.organization_id tickets.tags = users.tags tickets.requester_id = users.id tickets.follower_ids = users.id tickets.submitter_id = users.id tickets.collaborator_ids = users.id tickets.assignee_id = users.id
tags	tickets.tags = tags.name
ticket_fields	tickets.custom_fields.id = ticket_fields.id
ticket_forms	tickets.custom_fields.id = ticket_forms.ticket_field_ids tickets.ticket_form_id = ticket_forms.id
ticket_audits	tickets.id = ticket_audits.ticket_id tickets.requester_id = ticket_audits.author_id tickets.follower_ids = ticket_audits.author_id tickets.submitter_id = ticket_audits.author_id tickets.collaborator_ids = ticket_audits.author_id tickets.assignee_id = ticket_audits.author_id
ticket_comments	tickets.id = ticket_comments.ticket_id tickets.requester_id = ticket_comments.author_id tickets.follower_ids = ticket_comments.author_id tickets.submitter_id = ticket_comments.author_id tickets.collaborator_ids = ticket_comments.author_id tickets.assignee_id = ticket_comments.author_id
ticket_metrics	tickets.id = ticket_metrics.ticket_id

allow_attachments

BOOLEAN

allow_channelback

BOOLEAN

assignee_id

INTEGER

brand_id

INTEGER

collaborator_ids

ARRAY

This is a nested data structure.

created_at

DATE-TIME

custom_fields

ARRAY

This is a nested data structure:

id: INTEGER

description

STRING

due_at

DATE-TIME

email_cc_ids

ARRAY

This is a nested data structure.

external_id

STRING

follower_ids

ARRAY

This is a nested data structure.

followup_ids

ARRAY

This is a nested data structure.

forum_topic_id

INTEGER

generated_timestamp

INTEGER

group_id

INTEGER

has_incidents

BOOLEAN

INTEGER

is_public

BOOLEAN

organization_id

INTEGER

priority

STRING

problem_id

INTEGER

raw_subject

STRING

recipient

STRING

requester_id

INTEGER

satisfaction_rating

OBJECT, STRING

This is a nested data structure:

assignee_id: INTEGER
comment: STRING
created_at: DATE-TIME
group_id: INTEGER
id: INTEGER
reason: STRING
reason_id: INTEGER
requester_id: INTEGER
score: STRING
ticket_id: INTEGER
updated_at: DATE-TIME
url: STRING

sharing_agreement_ids

ARRAY

This is a nested data structure.

status

STRING

subject

STRING

submitter_id

INTEGER

tags

ARRAY

This is a nested data structure.

ticket_form_id

INTEGER

type

STRING

updated_at

DATE-TIME

url

STRING

via

OBJECT

This is a nested data structure:

channel: STRING
source: OBJECT, which is also a nested data structure.
- from: OBJECT, which is also a nested data structure.
  - address: STRING
  - name: STRING
  - subject: STRING
  - ticket_id: INTEGER
- rel: STRING
- to: OBJECT, which is also a nested data structure.
  - address: STRING
  - name: STRING

users

The users table contains info about the users associated with your Zendesk Support account. This includes agents, admins, and end-users (customers).

Note: Retrieving user data requires Zendesk Support Admin permissions.

Custom user fields

Zendesk Support integration will replicate any custom fields associated with user records.

Note: Replicating user custom fields requires that you be on a Team, Professional, or Enterprise Zendesk Support plan.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Zendesk Support documentation Zendesk Support API method

Join users with	on
groups	users.default_group_id = groups.id users.id = groups.id
group_memberships	users.default_group_id = group_memberships.group_id
organizations	users.default_group_id = organizations.group_id users.organization_id = organizations.id users.tags = organizations.tags
satisfaction_ratings	users.default_group_id = satisfaction_ratings.group_id users.id = satisfaction_ratings.assignee_id users.id = satisfaction_ratings.requester_id
tickets	users.default_group_id = tickets.group_id users.organization_id = tickets.organization_id users.tags = tickets.tags users.id = tickets.requester_id users.id = tickets.follower_ids users.id = tickets.submitter_id users.id = tickets.collaborator_ids users.id = tickets.assignee_id
macros	users.id = macros.restriction.id
tags	users.tags = tags.name
ticket_audits	users.id = ticket_audits.author_id
ticket_comments	users.id = ticket_comments.author_id

active

BOOLEAN

alias

STRING

chat_only

BOOLEAN

created_at

DATE-TIME

custom_role_id

INTEGER

default_group_id

INTEGER

details

STRING

email

STRING

external_id

STRING

INTEGER

last_login_at

DATE-TIME

locale

STRING

locale_id

INTEGER

moderator

BOOLEAN

name

STRING

notes

STRING

only_private_comments

BOOLEAN

organization_id

INTEGER

permanently_deleted

BOOLEAN

phone

STRING

photo

OBJECT

This is a nested data structure.

report_csv

BOOLEAN

restricted_agent

BOOLEAN

role

STRING

role_type

INTEGER

shared

BOOLEAN

shared_agent

BOOLEAN

shared_phone_number

BOOLEAN

signature

STRING

suspended

BOOLEAN

tags

ARRAY

This is a nested data structure.

ticket_restriction

STRING

time_zone

STRING

two_factor_auth_enabled

BOOLEAN

updated_at

DATE-TIME

url

STRING

user_fields

OBJECT

This is a nested data structure.

verified

BOOLEAN

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here