Sprinkle Docs
  • What is Sprinkle?
  • Quick Start
  • Analysing your data
    • 🔭Analytics Overview
    • 💠Data Models
      • *️Variables
      • 🌲Hierarchies
      • 🤿Column Mask
    • 🎉Switch to New Reports & Dashboards
    • 🆕Reports
      • Overview
      • Build Using Tables
        • Create a new Report
        • Layout and options
        • Build and Format - Overview
        • Apply Row Limits
        • Identify Date Columns
        • Filter your data
        • Visualizations
          • Table
          • Pivot
          • Line Chart
          • Bar Chart
          • Column Chart
          • Area Chart
          • Combo Chart
          • Scatter & Bubble Plot
          • Pie Chart
          • Funnel Chart
          • Stat Card
          • Point Map
          • Heat Map
          • Radial gauge chart
        • Advanced Features
          • Custom Analysis
          • Variables
          • Table & Quick Calculations
          • Drill - Hierarchical & Date
          • Break Out
          • RLS in Table reports
          • Scheduled Exports
          • Embedding Table Reports
      • Build Using Models
        • Create a new report
        • Layout and options
        • Visualizations
        • Advanced Features
      • Build SQL Reports
        • Create a new Report
        • Layout and options
        • Writing a SQL Code on Editor
        • Visualizations
        • Variables in SQL Reports
    • 🆕Dashboards
      • 🌀Filters
      • 👆Click Behaviour
      • ⏰Data Alerts
      • 🗓️Date Drill
      • 📤Scheduled Exports
      • 🔗Embed link
      • 🖥️Dashboard layout
      • 📱Mobile Dashboards
  • Transforming your data
    • 🔰SQL Transform
    • 📓Python Notebooks
  • Integrating your data
    • ☁️Destination Warehouses
      • AWS Athena
        • Manage storage of Flow tables
      • AWS Redshift
      • Azure Synapse
      • Databricks
      • Google BigQuery
      • MySQL
      • Postgres
      • Snowflake
      • SQL Server
      • K8 Setup
        • AWS EKS
        • Google GKE
        • Azure AKS
    • ⚙️Warehouse & Storage Setup
  • Ingesting your data
    • ☄️Data Imports
      • Databases
        • Azure Cosmos DB
        • Azure Table Storage
        • Google BigQuery
        • Mongo DB
        • MySQL DB
        • Oracle DB
        • Postgres DB
        • SQL Server DB
        • Features
          • Ingestion Modes
          • Add Multiple Datasets
          • CDC Setup
            • CDC setup in Mysql
            • CDC setup in Postgres
            • CDC setup in Mongo
            • CDC setup in SQL Server
          • Destination Create Table Clause
          • SSH Tunnel Setup
      • Files
        • AWS S3
        • AWS S3 External
        • Azure Blob
        • FTP
        • Google Cloud Storage
        • Google Sheet
        • SFTP
      • Applications
        • Apple Search Ads
        • Appsflyer
        • Branch
        • Clevertap
        • Facebook Ads
        • Freshdesk
        • Freshsales
        • Google Ads
        • Google Ads V2
        • Google Analytics
        • Google Analytics 4
        • Google Analytics MCF
        • Google Search Console
        • Hubspot
        • Impact Ads
        • Intercom
        • Klaviyo
        • Leadsquared
        • LinkedIn Ads
        • Magento
        • Mailchimp
        • Marketo
        • Mixpanel
        • MoEngage
        • Rocketlane
        • Salesforce
        • SAP S4
        • Shopify
        • Snapchat Marketing
        • TikTok Ads
        • WooCommerce
        • Zendesk Chat
        • Zendesk Support
        • Zoho Analytics
        • Zoho Books
        • Zoho CRM
        • Zoho Desk
        • Zoho Invoice
        • Zoho Subscription
      • Events
        • Apache Kafka
        • AWS Kinesis
        • Azure EventHub
    • 📤File Uploads
    • 🤖API Pulls
    • 🕸️Webhooks
  • Collaborating on data
    • 📤Sharing
    • 💬Comments
    • ⚡Activity
    • 🏷️Labels
  • Managing Schedules and Data Refreshes
    • ⏱️Schedules
    • 🔔Notifications
  • User Management
    • 🔑Access Management
    • 🧑‍🤝‍🧑Groups
    • 📂Folders
    • 🔄Syncing users, groups and RLS
    • 📧Azure AD Integration
  • Data Security & Privacy
    • 🔐Security at Sprinkle
    • 📄GDPR
    • 📄Privacy Policy
  • Release Notes
    • 📢Release Notes
      • 🗒️Release Notes - v12.1 (New)
      • 🗒️Release Notes - v12.0
      • 🗒️Release Notes - v11.0
      • 🗒️Release Notes - v10.8
      • 🗒️Release Notes - v10.7
      • 🗒️Release Notes - v10.6
      • 🗒️Release Notes - v10.5
      • 🗒️Release Notes - v10.4
      • 🗒️Release Notes - v10.3
      • 🗒️Release Notes - v10.2
      • 🗒️Release Notes - v10.1
      • 🗒️Release Notes - v10.0
      • 🗒️Release Notes - v9.31
      • 🗒️Release Notes - v9.30
      • 🗒️Release Notes - v9.29
      • 🗒️Release Notes - v9.28
      • 🗒️Release Notes - v9.27
      • 🗒️Release Notes - v9.25
      • 🗒️Release Notes - v9.24
      • 🗒️Release Notes - v9.23
      • 🗒️Release Notes - v9.22
      • 🗒️Release Notes - v9.21
      • 🗒️Release Notes - v9.20
      • 🗒️Release Notes - v9.19
      • 🗒️Release Notes - v9.18
      • 🗒️Release Notes - v9.17
      • 🗒️Release Notes - v9.16
      • 🗒️Release Notes - v9.14
      • 🗒️Release Notes - v9.13
      • 🗒️Release Notes - v9.12
      • 🗒️Release Notes -v9.8
      • 🗒️Release Notes - v9.7
      • 🗒️Release Notes - v9.6
      • 🗒️Release Notes - v9.5
      • 🗒️Release Notes - v9.4
      • 🗒️Release Notes - v9.3
      • 🗒️Release Notes - v9.2
      • 🗒️Release Notes - v9.1
      • 🗒️Release Notes - v9.0 (Major)
      • 🗒️Release Notes - v7.23
      • 🗒️Release Notes - v7.21
      • 🗒️Release Notes - v7.20
      • 🗒️Release Notes - v7.15
      • 🗒️Release Notes - v7.14
      • 🗒️Release Notes - v7.13
Powered by GitBook
On this page
  • Datasource Concepts
  • Step by Step Guide
  • STEP-1: Configure Connection
  • STEP-2: Configure Datasource
  • STEP-3: Create Dataset
  • STEP-4: Run and schedule Ingestion
  • Advanced Connection Settings
  • Dataset Fields
  1. Ingesting your data
  2. Data Imports
  3. Applications

Zendesk Chat

Guide to integrate your Zendesk Chat with Sprinkle

PreviousWooCommerceNextZendesk Support

Last updated 1 year ago

Datasource Concepts

Before setting up the datasource, learn about datasource concepts

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer

  • Log into Sprinkle application

  • Navigate to Datasources -> Connections Tab -> New Connection ->

  • Select Zendesk Chat

  • Provide all the mandatory details

    • Name: Name to identify this connection

    • Sub Domain: Only Give {SUBDOMAIN}. For ex:- https://{SUBDOMAIN}.zendesk.com

    • Advance Settings: Refer

  • Connect to Zendesk Chat: Sprinkle will ask the permission to read the data. Allow it.

  • Test Connection

  • Create

STEP-2: Configure Datasource

  • Navigate to Datasources -> Datasources Tab -> Add ->

  • Select Zendesk Chat

  • Provide the name -> Create

  • Connection Tab:

    • From the drop-down, select the name of connection created in STEP-2

    • Update

STEP-3: Create Dataset

  • Report Type (Required): Select from the drop-down.

  • 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_<datasourcename>_<tablename>

  • Create

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 Settings

  • 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 Chat API being used.

Dataset Fields

Agents
  • last_name

  • email

  • skills

  • enabled

  • departments

  • create_date

  • display_name

  • id

  • first_name

  • enabled_departments

  • role_id

  • last_login

  • login_count

  • roles_administrator

  • roles_owner

Accounts
  • account_key

  • create_date

  • status

  • plan_goals

  • plan_long_desc

  • plan_price

  • plan_short_desc

  • plan_widget_customization

  • plan_max_agents

  • plan_sla

  • plan_monitoring

  • plan_rest_api

  • plan_email_reports

  • plan_daily_reports

  • plan_chat_reports

  • plan_agent_reports

  • plan_agent_leaderboard

  • plan_unbranding

  • plan_high_load

  • plan_ip_restriction

  • plan_support

  • plan_name

  • plan_max_basic_triggers

  • plan_max_advanced_triggers

  • plan_max_departments

  • plan_max_concurrent_chats

  • plan_max_history_search_days

  • plan_operating_hours

  • plan_file_upload

  • plan_analytics

  • plan_integrations

Shortcuts
  • scope

  • name

  • id

  • options

  • tags_0_

  • message

  • tags

Trigger
  • definition_actions_0__0_

  • definition_actions_0__1_

  • definition_actions_1__0_

  • definition_actions_1__1_

  • definition_actions_1__2_

  • definition_event

  • definition_condition_0_

  • definition_condition_1__0_

  • definition_condition_1__1__0_

  • definition_condition_2__0_

  • definition_condition_2__1__0_

  • definition_condition_2__1__1_

  • definition_condition_2__1__2_

  • definition_condition_2__2__0_

  • definition_condition_2__2__1_

  • definition_condition_2__3__0_

  • definition_condition_2__3__1_

  • definition_condition_2__3__2_

  • enabled

  • name

  • id

  • description

  • definition_version

  • definition_condition_1__1_

  • definition_condition_1__2_

  • definition_condition_2__1_

  • definition_condition_3__0_

  • definition_condition_3__1_

  • definition_condition_3__2_

  • definition_condition_4__0_

  • definition_condition_4__1_

  • definition_condition_4__2_

  • definition_condition_5__0_

  • definition_condition_5__1__0_

  • definition_actions_0__2_

  • definition_condition_2__2_

  • definition_condition_3__1__0_

Roles
  • name

  • permissions_visitors_seen

  • permissions_proactive_chatting

  • permissions_edit_visitor_information

  • permissions_edit_visitor_notes

  • permissions_view_past_chats

  • permissions_edit_chat_tags

  • permissions_manage_bans

  • permissions_access_analytics

  • permissions_view_monitor

  • permissions_edit_department_agents

  • permissions_set_agent_chat_limit

  • permissions_manage_shortcuts

  • enabled

  • description

  • id

  • members_count

Chat
  • id

  • department_id

  • department_name

  • visitor

  • type

  • session

  • timestamp

  • unread

  • message

  • zendesk_ticket_id

Banned_IPs
  • created_at

  • id

  • ip_address

  • reason

  • type

  • visitor_id

  • visitor_name

Banned_Visitors
  • banned

  • created

  • email

  • external_id

  • id

  • name

  • notes

  • phone

Departments
  • description

  • enabled

  • id

  • members

  • name

  • settings

Goals
  • attribution_model

  • attribution_period

  • description

  • enabled

  • id

  • name

  • settings

Skills
  • description

  • enabled

  • id

  • members

  • name

To learn about datasource, refer

Datasets Tab: To learn about Dataset, refer . Add Dataset for each report/dataset that you want to integrate, providing following details

Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. on how to use this field.

☄️
here
here
Learn more
here
here
here