| Release Status | Released | Availability | Premium |
| Status Page | Desk Status Page | Default Historical Sync | 1 year |
| Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
| Full Table Endpoints | 2 | Incremental Endpoints | 3 |
| Destination Incompatibilities | None | ||
Connecting Desk
Connecting your Desk data to Stitch is a six-step process:
- Add Stitch as an app in your Desk account
- Retrieve your Desk Key and Secret
- Retrieve your Desk Token and Token Secret
- Add Desk as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
Adding Stitch as an App in Your Desk Account
- Sign into your Desk account.
- Navigate to the Admin panel by clicking the link in the upper left section of the Agent interface.
- In the Admin panel, click the Settings option in the menu at the top of the window.
- When the Settings page displays, click the API option in the menu that appears on the left side of the window.
- Click the +Add API Application button.
- After clicking the button, a window will display. This is where the initial parameters for the API application are set. Complete the fields as follows:
- Name: Stitch
- Website URL: http://www.stitchdata.com
- Callback URL: http://www.stitchdata.com
- Support URL: http://docs.stitchdata.com
- When finished, click the Add button.
Retrieving Your Desk Key & Secret
- After the URL parameters have been successfully submitted, a screen detailing the parameters, Key, and Secret will display.
- Copy the Key and Secret into a text file - you’ll need easy access to them to complete the setup.
Retrieving Your Desk Token & Token Secret
- Click the Your Access Token link on the right side of the API Application page. A window containing your Token and Token Secret will display.
- Copy the Token and Token Secret into the text file that contains your Key and Secret. Be careful not to mix up the Secret and Token Secret or you’ll encounter errors when saving the integration in Stitch.
Add Desk as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the Desk icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch Desk” would create a schema called
stitch_deskin the data warehouse. This schema is where all the tables for this integration will be stored. - In the Site URL field, enter your Desk.com website address. For example:
https://stitch.desk.com - Enter your Key, Secret, Token, and Token Secret into their respective fields.
Defining the Historical Sync
The Sync Historical Data setting will define the starting date for your Desk integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to sync data beyond Desk’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your Desk integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often Desk is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
Desk’s Intial Sync
After you finish setting up Desk, you might see its Sync Status show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial sync for the integration. This may take some time to complete.
Desk Schema
Stitch's Desk integration includes these tables:
cases
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
cases table contains about the support cases in your Desk account.cases & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
In addition to the fields listed below, our Desk integration will also include any custom fields.
cases Attributes
While we try to include everything Desk has here, this may not be a full list of attributes. Refer to Desk's documentation for a full list and description of each attribute.
Case ID (
id)external_id
blurb
subject
priority
description
status
type
labels
*locked_until
changed_at
active_at
language
suppress_rules
received_at
first_opened_at
last_opened_at
first_resolved_at
resolved_at
created_at
updated_at
customers
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
customers table contains about the end-users in your Desk account.customers & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
In addition to the fields listed below, our Desk integration will also include any custom fields.
customers Attributes
While we try to include everything Desk has here, this may not be a full list of attributes. Refer to Desk's documentation for a full list and description of each attribute.
Customer ID (
id)first_name
last_name
company
title
avatar
uid
background
language
locked_until
created_at
updated_at
emails
*phone numbers
*addresses
*access_private_portal
access_company_cases
replies
Replication Method: Incremental
Primary Key: case_id:reply_id
Contains Nested Structures?:
No
replies table contains the individual replies in cases.Depending on the configuration of your Desk account, you may see more fields in this table than what’s listed here. For example: Tweet fields.
replies Attributes
While we try to include everything Desk has here, this may not be a full list of attributes. Refer to Desk's documentation for a full list and description of each attribute.
Case ID
Reply ID
subject
body
direction (in vs. out)
status
to
from
cc
bcc
client_type
suppress_rules
sent_by
sent_at
created_at
updated_at
users
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
users table contains about the internal users of your Desk account.users Attributes
While we try to include everything Desk has here, this may not be a full list of attributes. Refer to Desk's documentation for a full list and description of each attribute.
User ID (
id)name
public_name
email
email_verified
avatar
level
current_login_at
last_login_at
created_at
updated_at
user_groups
Replication Method: Full Table
Primary Key: user_id:id
Contains Nested Structures?:
No
user_groups table contains the groups your internal users belong to.user_groups Attributes
While we try to include everything Desk has here, this may not be a full list of attributes. Refer to Desk's documentation for a full list and description of each attribute.
Group ID (
id)User ID (
user_id)Group Name
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, please reach out to us.