This integration is certified by Stitch. For support, contact Stitch support.
Desk integration summary
Stitch’s Desk integration replicates data using the Desk API. Refer to the Schema section for a list of objects available for replication.
Desk feature snapshot
A high-level look at Stitch's Desk (v15-10-2015) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on October 15, 2015 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Not available |
| Singer GitHub repository |
Not applicable |
||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Unsupported |
Column selection |
Unsupported |
| Select all |
Unsupported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Desk
Step 1: 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:
https://www.stitchdata.com - Callback URL:
https://www.stitchdata.com - Support URL:
https://www.stitchdata.com
- Name:
- When finished, click the Add button.
Step 2: Retrieve your Desk key and 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.
Step 3: Retrieve your Desk token and 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.
Step 4: Add Desk as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Desk icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Desk” would create a schema called
stitch_deskin the destination. Note: Schema names cannot be changed after you save the integration. - 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.
Step 5: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Desk integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Desk’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 6: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Desk integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Desk, its Sync Status may 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 replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Desk table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 15-10-2015 of this integration.
This is the latest version of the Desk integration.
cases
Replication Method: Key-based 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: Key-based 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: Key-based 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, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.