Zendesk ETL
Zendesk ETL connector for data replication
Snapshot
Features | Details |
Release Status | Released |
Source API Version | |
Table Selection | Yes |
Column Selection | Yes |
Edit Integration | Yes |
Replication Type Selection | No |
Authentication Parameters | Zendesk Subdomain Zendesk LoginId Zendesk Password |
Replication Type | Key Based Replication |
Replication Key | Date |
Suggested Replication Frequency | 24 hrs |
Tables/APIs Supported | |
GroupMemberships | Groups |
Macros | Organizations |
SatisfactionRatings | Tags |
TicketComments | TicketFields |
TicketForms | TicketMetrics |
Tickets | Users |
Integrate Zendesk with Daton
Signin to Daton
Select Zendesk from Integrations page
Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later
Provide Zendesk Subdomain, LoginId, and Password to authorize Daton to periodically extract data from Zendesk
Post successful authentication, you will be prompted to choose from the list of available tables
Then select all required fields for each table
Submit the integration
Workflow
Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
Users would be able to edit/pause/re-activate/delete integration anytime
Users can view job status and process logs from the integration details page by clicking on the integration name from the active list
Zendesk Data
GroupMemberships
Purpose: A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/group_memberships
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
url | STRING |
user_id | INTEGER |
group_id | INTEGER |
created_at | DATETIME |
updated_at | DATETIME |
Groups
Purpose: Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/groups
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
url | STRING |
name | STRING |
deleted | BOOLEAN |
updated_at | DATETIME |
created_at | DATETIME |
Macros
Purpose: A macro consists of one or more actions that modify the values of a ticket's fields. Macros are applied to tickets manually by agents. For example, you can create macros for support requests that agents can answer with a single, standard response.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/macros
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
restriction | RECORD |
actions | RECORD |
active | BOOLEAN |
description | STRING |
position | INTEGER |
title | STRING |
url | STRING |
updated_at | DATETIME |
created_at | DATETIME |
Organizations
Purpose: Just as agents can be segmented into groups in Zendesk Support, your customers (end-users) can be segmented into organizations. You can manually assign customers to an organization or automatically assign them to an organization by their email address domain. Organizations can be used in business rules to route tickets to groups of agents or to send email notifications.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/organizations
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
domain_names | RECORD |
external_id | STRING |
group_id | INTEGER |
name | STRING |
notes | STRING |
shared_tickets | BOOLEAN |
shared_comments | BOOLEAN |
organization_fields | STRING |
url | STRING |
SatisfactionRatings
Purpose: If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/satisfaction_ratings
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
updated_at | DATETIME |
assignee_id | INTEGER |
created_at | DATETIME |
group_id | INTEGER |
reason_id | INTEGER |
requester_id | INTEGER |
ticket_id | INTEGER |
url | STRING |
score | STRING |
reason | STRING |
comment | STRING |
Tags
Purpose: You must enable the tagging of users and organizations in Zendesk Support for the API calls to work.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/tags
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
name | STRING |
count | INTEGER |
ticket_audits id | INTEGER author_id | INTEGER ticket_id | INTEGER metadata | RECORD events | RECORD via | RECORD
TicketComments
Purpose: Ticket comments represent the conversation between requesters, collaborators, and agents. Comments can be public or private.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/ticket_comments
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
created_at | STRING |
body | STRING |
html_body | STRING |
plain_body | STRING |
public | BOOLEAN |
audit_id | INTEGER |
author_id | INTEGER |
attachments | RECORD |
viasourcerel | STRING |
via__channel | STRING |
TicketFields
Purpose: Zendesk Support allows admins to customize the fields displayed on the ticket form. Basic text fields as well as customizable dropdown and number fields are available. You can customize The visibility of these fields for end users in the admin interface.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/ticket_fields
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
created_at | STRING |
updated_at | STRING |
title_in_portal | STRING |
visible_in_portal | BOOLEAN |
collapsed_for_agents | BOOLEAN |
regexp_for_validation | STRING |
title | STRING |
position | INTEGER |
type | STRING |
editable_in_portal | BOOLEAN |
raw_title_in_portal | STRING |
tag | STRING |
removable | BOOLEAN |
active | BOOLEAN |
url | STRING |
raw_title | STRING |
required | BOOLEAN |
description | STRING |
raw_description | STRING |
agent_description | STRING |
required_in_portal | STRING |
custom_field_options | RECORD |
TicketForms
Purpose: Returns a list of all ticket forms for your account if accessed as an admin or agent. End users will only see the list of ticket forms that are marked 'end_user_visible'.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/ticket_forms
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
updated_at | STRING |
created_at | STRING |
name | STRING |
raw_name | STRING |
display_name | STRING |
raw_display_name | STRING |
url | STRING |
position | INTEGER |
active | BOOLEAN |
default | BOOLEAN |
end_user_available | BOOLEAN |
in_all_brands | BOOLEAN |
ticket_field_ids | RECORD |
restricted_brand_ids | RECORD |
TicketMetrics
Purpose: Returns a list of tickets with their metrics. Tickets are ordered chronologically by created date, from newest to oldest. The last ticket listed may not be the absolute oldest ticket in your account due to ticket archiving.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/ticket_metrics
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
updated_at | STRING |
group_stations | INTEGER |
assignee_stations | INTEGER |
created_at | STRING |
reopens | INTEGER |
replies | INTEGER |
assignee_updated_at | DATETIME |
requester_updated_at | DATETIME |
status_updated_at | DATETIME |
initially_assigned_at | DATETIME |
assigned_at | DATETIME |
solved_at | DATETIME |
latest_comment_added_at | DATETIME |
reply_time_in_minutes | RECORD |
first_resolution_time_in_minutes | RECORD |
full_resolution_time_in_minutes | RECORD |
agent_wait_time_in_minutes | RECORD |
requester_wait_time_in_minutes | RECORD |
on_hold_time_in_minutes | RECORD |
Tickets
Purpose: Tickets are the means through which your end users (customers) communicate with agents in Zendesk Support. Tickets can originate from a number of channels, including email, Help Center, chat, phone call, Twitter, Facebook, or the API. All tickets have a core set of properties.
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/tickets
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
updated_at | STRING |
organization_id | INTEGER |
requester_id | INTEGER |
is_public | BOOLEAN |
description | STRING |
follower_ids | RECORD |
submitter_id | INTEGER |
brand_id | INTEGER |
group_id | INTEGER |
type | STRING |
collaborator_ids | RECORD |
tags | RECORD |
has_incidents | BOOLEAN |
created_at | STRING |
raw_subject | STRING |
status | STRING |
custom_fields | RECORD |
url | STRING |
allow_channelback | BOOLEAN |
due_at | STRING |
followup_ids | RECORD |
priority | STRING |
assignee_id | INTEGER |
subject | STRING |
external_id | STRING |
Users
Purpose: Returns all user details
Source API Documentation https://developer.zendesk.com/rest_api/docs/support/users#list-users
Replication: Key-Based Replication
Replication Key: created_at
Fields
Name | Target Datatype |
id | INTEGER |
updated_at | STRING |
active | BOOLEAN |
alias | STRING |
chat_only | BOOLEAN |
custom_role_id | INTEGER |
created_at | STRING |
default_group_id | INTEGER |
details | STRING |
STRING | |
external_id | STRING |
last_login_at | STRING |
locale | STRING |
locale_id | INTEGER |
name | STRING |
notes | STRING |
moderator | BOOLEAN |
organization_id | INTEGER |
only_private_comments | BOOLEAN |
phone | STRING |
photo | RECORD |
role | STRING |
role_type | INTEGER |
shared | BOOLEAN |
shared_agent | BOOLEAN |
shared_phone_number | BOOLEAN |
signature | STRING |
suspended | BOOLEAN |
tags | STRING |
ticket_restriction | STRING |
time_zone | STRING |
two_factor_auth_enabled | BOOLEAN |
url | STRING |
verified | BOOLEAN |
user_fields | RECORD |
Last updated