Zendesk Sunshine connector
Set up the Zendesk Sunshine connector in Kaivo: authentication, configuration, the 6 BigQuery tables it syncs, and answers to common questions.
Zendesk Sunshine connector pricing, tier and credits on kaivo.ioKaivo is a fully managed data platform that syncs your Zendesk Sunshine data into a Google BigQuery warehouse and keeps it up to date automatically. There is no pipeline to build and no infrastructure to run, so you can spend your time analysing your customer support data instead of moving it.
What is the Zendesk Sunshine connector
Section titled “What is the Zendesk Sunshine connector”Sync your Zendesk Sunshine custom object data into BigQuery with Kaivo so the custom data you model in Sunshine can be reported on.
| Category | Customer Service |
|---|---|
| Authentication | API key |
| Setup | Self-service |
Getting started with the Zendesk Sunshine connector
Section titled “Getting started with the Zendesk Sunshine connector”- Sign up for Kaivo and create a workspace.
- Connect your Zendesk Sunshine account.
- Choose which tables to sync.
- Wait for the initial sync to finish.
- Query your data in BigQuery or your favourite AI or BI tool.
Authenticating Zendesk Sunshine
Section titled “Authenticating Zendesk Sunshine”Authenticate with your Zendesk Sunshine credentials. You provide:
| Field | Description |
|---|---|
| The user email for your Zendesk account. |
| | API Token |
The API token for your Zendesk account. See the Zendesk documentation for more information on generating this token.
|
Configuring the Zendesk Sunshine connector
Section titled “Configuring the Zendesk Sunshine connector”When you set up the connector, you provide:
| Field | Description |
|---|---|
| Subdomain | |
| Your unique Zendesk subdomain found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is your subdomain. |
| | Start Date |
Any data before this date will not be fetched.
|
Tables and columns synced from Zendesk Sunshine
Section titled “Tables and columns synced from Zendesk Sunshine”Kaivo syncs 6 tables from Zendesk Sunshine into a dedicated dataset in your BigQuery warehouse. Click any table to see its columns and types.
limits (5 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
count |
INT64 |
The total count of the data records fetched |
key |
STRING |
The identifier key for the fetched data records |
limit |
INT64 |
The maximum limit allowed for fetching data records in a single request |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
object_records (7 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
type |
STRING |
The type or category of the object record. |
created_at |
STRING |
The timestamp indicating when the object record was created. |
external_id |
STRING |
The unique identifier for the object record in an external system. |
id |
STRING |
The unique identifier for the object record in the Zendesk Sunshine platform. |
updated_at |
STRING |
The timestamp indicating when the object record was last updated. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
object_type_policies (15 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
object_type |
STRING |
The type of object for which the permissions are being defined. |
rbac__admin__create |
BOOL |
Permission to create new objects of this type. |
rbac__admin__delete |
BOOL |
Permission to delete objects of this type. |
rbac__admin__read |
BOOL |
Permission to read/view objects of this type. |
rbac__admin__update |
BOOL |
Permission to update/edit objects of this type. |
rbac__agent__create |
BOOL |
Permission to create new objects of this type. |
rbac__agent__delete |
BOOL |
Permission to delete objects of this type. |
rbac__agent__read |
BOOL |
Permission to read/view objects of this type. |
rbac__agent__update |
BOOL |
Permission to update/edit objects of this type. |
rbac__end_user__create |
BOOL |
Permission to create new objects of this type. |
rbac__end_user__delete |
BOOL |
Permission to delete objects of this type. |
rbac__end_user__read |
BOOL |
Permission to read/view objects of this type. |
rbac__end_user__update |
BOOL |
Permission to update/edit objects of this type. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
object_types (5 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
created_at |
STRING |
The date and time when the object type was created. |
key |
STRING |
The unique identifier for the object type. |
updated_at |
STRING |
The date and time when the object type was last updated. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
Subtable: object_types__schema__required
Section titled “Subtable: object_types__schema__required”| Column | Type | Description |
|---|---|---|
_kaivo_parent_id |
STRING |
Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo. |
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
value |
STRING |
The name of a required property. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
relationship_records (7 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
created_at |
STRING |
The timestamp indicating when the relationship record was created. |
id |
STRING |
The unique identifier for the relationship record. |
relationship_type |
STRING |
The type of relationship between the source and target entities. |
source |
STRING |
The entity that initiated the relationship. |
target |
STRING |
The entity that is the target of the relationship. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
relationship_types (7 columns)
| Column | Type | Description |
|---|---|---|
_kaivo_id |
STRING |
Primary key that uniquely identifies the row. Auto-generated by Kaivo. |
created_at |
STRING |
The timestamp representing when the relationship type was created. |
key |
STRING |
A unique identifier for the relationship type. |
source |
STRING |
The entity that is the source of the relationship. |
target |
STRING |
The entity that is the target of the relationship. |
updated_at |
STRING |
The timestamp representing when the relationship type was last updated. |
_kaivo_extracted_at |
TIMESTAMP |
Timestamp that shows when the row was extracted. Auto-generated by Kaivo. |
How the Zendesk Sunshine sync works
Section titled “How the Zendesk Sunshine sync works”After the first load, Kaivo keeps your BigQuery warehouse up to date for you. Where Zendesk Sunshine supports it, each sync pulls only new and changed records so it stays fast; otherwise it refreshes the whole table. Every record keeps its original ID, so you won’t get duplicate rows.
Frequently asked questions
Section titled “Frequently asked questions”How long does the initial sync take for Zendesk Sunshine?
Section titled “How long does the initial sync take for Zendesk Sunshine?”It depends on how much history is in your Zendesk Sunshine account. Most initial syncs finish within minutes, while large accounts can take a few hours. After that, syncs only fetch new and changed records, so they’re much faster.
Can I sync only some tables or columns?
Section titled “Can I sync only some tables or columns?”Yes. You pick which tables to sync when you set up the connection and can change the selection later. Tables you don’t select are never copied to your warehouse.
What happens when Zendesk Sunshine’s schema changes?
Section titled “What happens when Zendesk Sunshine’s schema changes?”New fields are never added automatically. You choose which fields to sync, so data you haven’t selected (sensitive personal data, for example) never lands in your warehouse. When a new field appears, it becomes available for you to add. What happens to removed or renamed fields depends on a table’s sync mode: full-refresh tables always match what’s currently in Zendesk Sunshine, so dropped fields disappear, while incremental tables keep their existing columns and history, so an old field stays and newly added fields fill in over time.
How do I handle GDPR or data deletion requests?
Section titled “How do I handle GDPR or data deletion requests?”Your data lives in your own Kaivo-managed BigQuery warehouse, so the most direct option is to delete or anonymise specific records right in BigQuery. If you delete data in Zendesk Sunshine instead, full-refresh tables drop it on the next sync, while incremental tables keep it, so you would remove the row in BigQuery or ask us to run a full refresh. To remove everything, delete the Zendesk Sunshine connector in Kaivo and all of its synced data is deleted with it.
Common use cases for Zendesk Sunshine data
Section titled “Common use cases for Zendesk Sunshine data”Custom object reporting
Section titled “Custom object reporting”Use object_records and object_types to report on the data you model in Sunshine.
Relationship analysis
Section titled “Relationship analysis”Join relationship_records with relationship_types to understand how your data connects.
Combine with other sources
Section titled “Combine with other sources”Bring Sunshine data into BigQuery to join it with your support and CRM data.
Use Zendesk Sunshine data in your AI and BI tools
Section titled “Use Zendesk Sunshine data in your AI and BI tools”Once Zendesk Sunshine data lands in your Kaivo-managed BigQuery warehouse, you can explore it with AI tools or any BI tool that connects to BigQuery. Here’s how the most common destinations work with Zendesk Sunshine data.
Claude
Section titled “Claude”Use Kaivo’s MCP server to give Claude secure, workspace-scoped access to your data. Setup guide →
Power BI
Section titled “Power BI”Microsoft’s BI tool with a native BigQuery connector. Supports direct query and scheduled refresh. Setup guide →
Data Studio
Section titled “Data Studio”Free Google BI tool with native BigQuery support. One-click connection to your Kaivo warehouse; great for SMB teams on Google Workspace. Setup guide →
Tableau
Section titled “Tableau”The premium analytics standard, with native BigQuery integration. Setup guide →
Google Sheets
Section titled “Google Sheets”Use Connected Sheets to query BigQuery directly from a spreadsheet, with no SQL. Setup guide →
Connect via Power Query’s BigQuery connector. Setup guide →
Metabase
Section titled “Metabase”Open-source BI tool with strong BigQuery support. Setup guide →
See our pricing page for Zendesk Sunshine connector pricing and plan details.