Zendesk Support
Pipeline Concepts
Section titled βPipeline ConceptsβBefore setting up the Pipeline, learn about Pipeline concepts here
Step by Step Guide
Section titled βStep by Step GuideβSTEP-1: Configure Connection
Section titled βSTEP-1: Configure ConnectionβTo learn about Connection, refer here
- Log into Sprinkle application
- Navigate to Ingest -> Connections Tab -> New Connection ->
- Select Zendesk Support
- Provide all the mandatory details
- Name: Name to identify this connection
- Sub Domain: Only Give {SUBDOMAIN}. For ex:- https://{SUBDOMAIN}.zendesk.com
- Email Id: Give Email ID connected to your zendesk account
- API Token: API token for zendesk account.
(Refer the link to generate API Token - https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token ) - Advance Settings: Refer here
- Test Connection
- Create
STEP-2: Configure Pipeline
Section titled βSTEP-2: Configure PipelineβTo learn about Pipeline, refer here
- Navigate to Ingest -> Pipeline Tab -> Add ->
- Select Zendesk Support
- Provide the name -> Create
- Connection Tab:
- From the drop-down, select the name of connection created in STEP-2
- Update
STEP-3: Create Dataset
Section titled βSTEP-3: Create DatasetβDatasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
- Report Type (Required): Select from the drop-down:
- Groups
- Group_Memberships
- Organizations
- Organization_Memberships
- Satisfaction_Ratings
- Macros
- Tickets
- Suspended_Tickets
- Ticket_Metrics
- Ticket_Fields
- Target_Failures
- Tags
- Brands
- Views
- Triggers
- Automations
- Targets
- Apps
- Sharing_Agreements
- Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
- Destination Schema (Required) : Data warehouse schema where the table will be ingested into
- Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<Pipelinename>_<tablename>
- Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
- Create
STEP-4: Run and schedule Ingestion
Section titled βSTEP-4: Run and schedule IngestionβIn the Ingestion Jobs tab:
- Trigger the Job, using Run button
- To schedule, enable Auto-Run. Change the frequency if needed
Advanced Connection Setting
Section titled βAdvanced Connection Settingβ- API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the serverβs response. The default value is 30 seconds
- API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
- Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
- Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
- API Delay Time (In milliseconds) : The time difference (in milliseconds) between two successive API calls.
- Version : it gives information about the version of Zendesk Support API being used.
Dataset Fields
Section titled βDataset FieldsβGroups
- url
- id
- is_public
- name
- description
- default
- deleted
- created_at
- updated_at
Group_Memberships
- url
- id
- user_id
- group_id
- default
- created_at
- updated_at
Organizations
- url
- id
- name
- shared_tickets
- shared_comments
- created_at
- updated_at
- domain_names
- tags
- organization_fields
Organization_Memberships
- url
- id
- user_id
- organization_id
- default
- created_at
- organization_name
- updated_at
- view_tickets
Satisfaction_Ratings
- assignee_id
- comment
- created_at
- group_id
- id
- reason
- reason_code
- requester_id
- score
- ticket_id
- updated_at
- url
Macros
- url
- id
- title
- active
- updated_at
- created_at
- position
- actions_0__field
- actions_0__value
- actions_1__field
- actions_1__value
- actions_2__field
- actions_2__value
- actions_3__field
- actions_3__value
- actions_4__field
- actions_4__value
- actions_5__field
- actions_5__value
Tickets
- url
- id
- via_channel
- via_source_from
- via_source_to
- created_at
- updated_at
- type
- subject
- raw_subject
- description
- priority
- status
- requester_id
- submitter_id
- assignee_id
- group_id
- collaborator_ids
- follower_ids
- email_cc_ids
- has_incidents
- is_public
- tags_0_
- tags_1_
- tags_2_
- custom_fields
- sharing_agreement_ids
- fields
- followup_ids
- ticket_form_id
- brand_id
- allow_channelback
- allow_attachments
Suspended_Tickets
- attachments
- author
- brand_id
- cause
- cause_id
- content
- created_at
- error_messages
- id
- message_id
- recipient
- subject
- tickey_id
- updated_at
- url
- via
Ticket_Metrics
- url
- id
- ticket_id
- created_at
- updated_at
- group_stations
- assignee_stations
- reopens
- replies
- assignee_updated_at
- requester_updated_at
- status_updated_at
- initially_assigned_at
- assigned_at
- latest_comment_added_at
- reply_time_in_minutes
- first_resolution_time_in_minutes
- full_resolution_time_in_minutes
- agent_wait_time_in_minutes
- requester_wait_time_in_minutes
- on_hold_time_in_minutes_calendar
- on_hold_time_in_minutes_business
Ticket_Fields
- url
- id
- type
- title
- raw_title
- description
- raw_description
- position
- active
- required
- collapsed_for_agents
- title_in_portal
- raw_title_in_portal
- visible_in_portal
- editable_in_portal
- required_in_portal
- created_at
- updated_at
- removable
- system_field_options_0__name
- system_field_options_0__value
- system_field_options_1__name
- system_field_options_1__value
- system_field_options_2__name
- system_field_options_2__value
- sub_type_id
- system_field_options_3__name
- system_field_options_3__value
Target_Failures
- consecutivefailurecount
- created_at
- id
- raw_request
- raw_response
- status_code
- target_name
- url
Tags
- name
- count
Brands
- url
- id
- name
- brand_url
- subdomain
- has_help_center
- help_center_state
- active
- default
- is_deleted
- ticket_form_ids_0_
- signature_template
- created_at
- updated_at
Views
- url
- id
- title
- active
- updated_at
- created_at
- position
- execution_group_by
- execution_group_order
- execution_sort_by
- execution_sort_order
- execution_group_id
- execution_group_title
- execution_sort_id
- execution_sort_title
- execution_columns_0__id
- execution_columns_0__title
- execution_columns_1__id
- execution_columns_1__title
- execution_columns_2__id
- execution_columns_2__title
- execution_columns_3__id
- execution_columns_3__title
- execution_columns_4__id
- execution_columns_4__title
- execution_fields_0__id
- execution_fields_0__title
- execution_fields_1__id
- execution_fields_1__title
- execution_fields_2__id
- execution_fields_2__title
- execution_fields_3__id
- execution_fields_3__title
- execution_fields_4__id
- execution_fields_4__title
- execution_custom_fields
- conditions_all_0__field
- conditions_all_0__operator
- conditions_all_0__value
- conditions_all_1__field
- conditions_all_1__operator
- conditions_all_1__value
- conditions_any
- watchable
- raw_title
- execution_columns_5__id
- execution_columns_5__title
- execution_fields_5__id
- execution_fields_5__title
- conditions_all_2__field
- conditions_all_2__operator
- conditions_all_2__value
Triggers
- url
- id
- title
- active
- updated_at
- created_at
- actions_0__field
- actions_0__value_0_
- actions_0__value_1_
- actions_0__value_2_
- conditions_all_0__field
- conditions_all_0__operator
- conditions_all_0__value
- conditions_any
- position
- raw_title
- category_id
- conditions_all_1__field
- conditions_all_1__operator
- conditions_all_1__value
- conditions_all_2__field
- conditions_all_2__operator
- conditions_all_2__value
- conditions_all_3__field
- conditions_all_3__operator
- conditions_all_4__field
- conditions_all_4__operator
- conditions_all_4__value
- conditions_any_0__field
- conditions_any_0__operator
- conditions_any_0__value
- conditions_any_1__field
- conditions_any_1__operator
- conditions_any_1__value
- conditions_all_3__value
- description actions_0__value
Automations
- url
- id
- title
- active
- updated_at
- created_at
- actions_0__field
- actions_0__value
- conditions_all_0__field
- conditions_all_0__operator
- conditions_all_0__value
- conditions_all_1__field
- conditions_all_1__operator
- conditions_all_1__value
- conditions_any
- position
- raw_title
- actions_0__value_0_
- actions_0__value_1_
- actions_0__value_2_
Targets
- active
- created_at
- id
- title
- type
Apps
- id
- name
- state
- version
- framework_version
- parameters_0__id
- parameters_0__app_id
- parameters_0__name
- parameters_0__kind
- parameters_0__required
- parameters_0__position
- parameters_0__created_at
- parameters_0__updated_at
- parameters_0__secure
- parameters_1__id
- parameters_1__app_id
- parameters_1__name
- parameters_1__kind
- parameters_1__required
- parameters_1__position
- parameters_1__created_at
- parameters_1__updated_at
- parameters_1__secure
- parameters_2__id
- parameters_2__app_id
- parameters_2__name
- parameters_2__kind
- parameters_2__required
- parameters_2__position
- parameters_2__created_at
- parameters_2__updated_at
- parameters_2__default_value
- parameters_2__secure
- parameters_3__id
- parameters_3__app_id
- parameters_3__name
- parameters_3__kind
- parameters_3__required
- parameters_3__position
- parameters_3__created_at
- parameters_3__updated_at
- parameters_3__default_value
- parameters_3__secure
- plans_0__id
- plans_0__entity_id
- plans_0__app_id
- plans_0__amount
- plans_0__description
- plans_0__plan_type
- plans_0__cost_id
- plans_0__cost_type
- plans_0__active
- plans_0__created_at
- plans_0__updated_at
- plans_0__trial_days
- rating_total_count
- rating_average
- rating_count_3
- rating_count_5
- rating_count_4
- rating_count_1
- rating_count_2
- single_install
- default_locale
- feature_color
- products_0_
- categories_0__id
- categories_0__name
- categories_1__id
- categories_1__name
- collections
- created_at
- updated_at
- terms_conditions_url
- app_organization_id
- app_organization_name
- app_organization_email
- app_organization_website
- app_organization_country_code
- locations_0_
- locations_1_
- date_published
- owner_id
- author_name
- author_email
- author_url
- short_description
- long_description
- installation_instructions
- raw_long_description
- raw_installation_instructions
- visibility
- promoted
- featured
- paid
- deprecated
- obsolete
- installable
- marketing_only
- small_icon
Sharing_Agreements
- created_at
- id
- name
- partner_name
- remote_subdomain
- status
- type
- url