# Help Scout (v1) Information note **Help Scout extraction is supported by Stitch** This integration is powered by [Singer's](https://www.singer.io/) Help Scout tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-helpscout). For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport). ## Help Scout integration summary Stitch’s Help Scout integration replicates data using the [Help Scout Mailbox API 2.0](https://developer.helpscout.com/mailbox-api/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#schema) section for a list of objects available for replication. ## Help Scout feature snapshot A high-level look at Stitch's Help Scout (v1) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on July 30, 2019 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-helpscout](https://github.com/singer-io/tap-helpscout) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Remove icon

Advanced Scheduling is not supported for this integration.


Unsupported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting Help Scout ### Help Scout setup requirements To set up Help Scout in Stitch, you need: * **An active, invited Help Scout user.** The Help Scout user setting up the integration in Stitch must be [active and invited in Help Scout](https://developer.helpscout.com/mailbox-api/overview/authentication/). To verify a user’s status, click **Manage > Users** in Help Scout. ### Step 1: Add Help Scout as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Help Scout** icon. 4. 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 Help Scout” would create a schema called `stitch_help_scout` in the destination. **Note**: Schema names cannot be changed after you save the integration. ### Step 2: Define the historical replication start date The Sync Historical Data setting defines the starting date for your Help Scout 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 replicate data beyond Help Scout’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 3: Create a replication schedule When finished, click the **Authorize** button to continue. ### Step 4: Authorize Stitch to access Help Scout ![](https://help.qlik.com/en-US/stitch/images/integrations/helpscout-authorize-stitch.png) 1. After you click **Authorize** in Stitch, you’ll be prompted to sign into your Help Scout account. Enter your Help Scout credentials and click **Log in**. 2. On the next page, click the **Authorize** button to continue. 3. After the authorization process is successfully completed, you’ll be directed back to Stitch. 4. Click **All Done**. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For Help Scout integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Initial and historical replication jobs After you finish setting up Help Scout, 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.** Information note **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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## Help Scout table reference Information note **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 1** of this integration. This is the latest version of the Help Scout integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### conversation\_threads The `conversation_threads` table contains info about the threads that make up [`conversations`](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations). | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | created\_at | | **Useful links** | [conversation_threads schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/conversation_threads.json "Opens in new tab: conversation_threads schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/list/ "Opens in new tab: Help Scout API method") | conversation\_threads table foreign keys | Join conversation\_threads with | on | | --- | --- | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
conversation_threads.conversation_id = conversations.id
```

```
conversation_threads.customer.id = conversations.primary_customer.id
```

```
conversation_threads.assigned_to.id = conversations.assignee.id
```

```
conversation_threads.created_by.id = conversations.assignee.id
```

```
conversation_threads.assigned_to.id = conversations.closed_by
```

```
conversation_threads.created_by.id = conversations.closed_by
```

```
conversation_threads.assigned_to.id = conversations.created_by.id
```

```
conversation_threads.created_by.id = conversations.created_by.id
``` | | [customers](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#customers) | ```
conversation_threads.customer.id = customers.id
``` | | [users](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#users) | ```
conversation_threads.assigned_to.id = users.id
```

```
conversation_threads.created_by.id = users.id
``` | conversation\_threads table schema | **action**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand action

text

STRING

type

STRING

| | --- | | **assigned\_to**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand assigned\_to

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

type

STRING

| | **attachments**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **bcc**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **body**


STRING | | **cc**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **conversation\_id**


INTEGER | | **created\_at**


DATE-TIME | | **created\_by**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand created\_by

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

type

STRING

| | **customer**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand customer

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

| | **id**


INTEGER | | **opened\_at**


DATE-TIME | | **saved\_reply\_id**


INTEGER | | **source**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand source

type

STRING

via

STRING

| | **state**


STRING | | **status**


STRING | | **to**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **type**


STRING | ### conversations The `conversations` table contains info about the conversations in your Help Scout mailbox. Stitch will replicate all conversations, including active, closed, open, pending, and spam. **Note**: If custom fields are available, Stitch will replicate them. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [conversations schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/conversations.json "Opens in new tab: conversations schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/ "Opens in new tab: Help Scout API method") | conversations table foreign keys | Join conversations with | on | | --- | --- | | [conversation_threads](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversation-threads) | ```
conversations.id = conversation_threads.conversation_id
```

```
conversations.primary_customer.id = conversation_threads.customer.id
```

```
conversations.assignee.id = conversation_threads.assigned_to.id
```

```
conversations.closed_by = conversation_threads.assigned_to.id
```

```
conversations.created_by.id = conversation_threads.assigned_to.id
```

```
conversations.assignee.id = conversation_threads.created_by.id
```

```
conversations.closed_by = conversation_threads.created_by.id
```

```
conversations.created_by.id = conversation_threads.created_by.id
``` | | [customers](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#customers) | ```
conversations.primary_customer.id = customers.id
``` | | [mailbox_folders](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-folders) | ```
conversations.folder_id = mailbox_folders.id
```

```
conversations.mailbox_id = mailbox_folders.mailbox_id
``` | | [mailbox_fields](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-fields) | ```
conversations.mailbox_id = mailbox_fields.mailbox_id
``` | | [mailboxes](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailboxes) | ```
conversations.mailbox_id = mailboxes.id
``` | | [workflows](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#workflows) | ```
conversations.mailbox_id = workflows.mailbox_id
``` | | [users](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#users) | ```
conversations.assignee.id = users.id
```

```
conversations.closed_by = users.id
```

```
conversations.created_by.id = users.id
``` | conversations table schema | **assignee**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand assignee

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

type

STRING

| | --- | | **bcc**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **cc**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **closed\_at**


DATE-TIME | | **closed\_by**


INTEGER | | **created\_at**


DATE-TIME | | **created\_by**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand created\_by

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

type

STRING

| | **custom\_fields**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand custom\_fields

id

INTEGER

name

STRING

text

STRING

value

STRING

| | **customer\_waiting\_since**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand customer\_waiting\_since

friendly

STRING

last_reply_from

STRING

time

DATE-TIME

| | **folder\_id**


INTEGER | | **id**


INTEGER | | **mailbox\_id**


INTEGER | | **number**


INTEGER | | **preview**


STRING | | **primary\_customer**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand primary\_customer

email

STRING

first

STRING

id

INTEGER

last

STRING

photo_url

STRING

type

STRING

| | **source**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand source

type

STRING

via

STRING

| | **state**


STRING | | **status**


STRING | | **subject**


STRING | | **tags**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand tags

color

STRING

id

INTEGER

tag

STRING

| | **threads**


INTEGER | | **type**


STRING | | **updated\_at**


DATE-TIME | | **user\_updated\_at**


DATE-TIME | ### customers The `customers` table contains info about the customers in your Help Scout account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [customers schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/customers.json "Opens in new tab: customers schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/customers/list/ "Opens in new tab: Help Scout API method") | customers table foreign keys | Join customers with | on | | --- | --- | | [conversation_threads](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversation-threads) | ```
customers.id = conversation_threads.customer.id
``` | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
customers.id = conversations.primary_customer.id
``` | customers table schema | **address**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand address

city

STRING

country

STRING

lines

ARRAY

postal_code

STRING

state

STRING

| | --- | | **age**


STRING | | **background**


STRING | | **chats**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand chats

id

INTEGER

type

STRING

value

STRING

| | **created\_at**


DATE-TIME | | **emails**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand emails

id

INTEGER

type

STRING

value

STRING

| | **first\_name**


STRING | | **gender**


STRING | | **id**


INTEGER | | **job\_title**


STRING | | **last\_name**


STRING | | **location**


STRING | | **organization**


STRING | | **phones**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand phones

id

INTEGER

type

STRING

value

STRING

| | **photo\_type**


STRING | | **photo\_url**


STRING | | **properties**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand properties

name

STRING

type

STRING

value

STRING

| | **social\_profiles**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand social\_profiles

id

INTEGER

type

STRING

value

STRING

| | **updated\_at**


DATE-TIME | | **websites**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand websites

id

INTEGER

value

STRING

| ### happiness\_ratings\_report The happiness ratings report provides a company’s ratings for a specified time range. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | conversation\_id

rating\_created\_at

rating\_customer\_id | | **Useful links** | [happiness_ratings_report schema on GitHub](https://github.com/singer-io/tap-helpscout/tree/master/tap_helpscout/schemas/happiness_ratings_report.json "Opens in new tab: happiness_ratings_report schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/reports-happiness-ratings/ "Opens in new tab: Help Scout API method") | happiness\_ratings\_report table schema | **conversation\_id**


INTEGER | | --- | | **rating\_comments**


STRING | | **rating\_created\_at**


DATE-TIME | | **rating\_customer\_id**


INTEGER | | **rating\_customer\_name**


STRING | | **rating\_id**


INTEGER | | **rating\_user\_id**


INTEGER | | **rating\_user\_name**


STRING | | **thread\_created\_at**


DATE-TIME | | **thread\_id**


INTEGER | | **type**


STRING | ### mailbox\_fields The `mailbox_fields` table contains info about the custom fields associated with your Help Scout mailboxes. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [mailbox_fields schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/mailbox_fields.json "Opens in new tab: mailbox_fields schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/mailbox-fields/ "Opens in new tab: Help Scout API method") | mailbox\_fields table foreign keys | Join mailbox\_fields with | on | | --- | --- | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
mailbox_fields.mailbox_id = conversations.mailbox_id
``` | | [mailbox_folders](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-folders) | ```
mailbox_fields.mailbox_id = mailbox_folders.mailbox_id
``` | | [mailboxes](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailboxes) | ```
mailbox_fields.mailbox_id = mailboxes.id
``` | | [workflows](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#workflows) | ```
mailbox_fields.mailbox_id = workflows.mailbox_id
``` | mailbox\_fields table schema | **id**


INTEGER | | --- | | **mailbox\_id**


INTEGER | | **name**


STRING | | **options**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand options

id

INTEGER

label

STRING

order

INTEGER

| | **order**


INTEGER | | **required**


BOOLEAN | | **type**


STRING | ### mailbox\_folders The `mailbox_folders` table contains info about the mailbox folders in your Help Scout account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [mailbox_folders schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/mailbox_folders.json "Opens in new tab: mailbox_folders schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/mailbox-folders/ "Opens in new tab: Help Scout API method") | mailbox\_folders table foreign keys | Join mailbox\_folders with | on | | --- | --- | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
mailbox_folders.id = conversations.folder_id
```

```
mailbox_folders.mailbox_id = conversations.mailbox_id
``` | | [mailbox_fields](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-fields) | ```
mailbox_folders.mailbox_id = mailbox_fields.mailbox_id
``` | | [mailboxes](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailboxes) | ```
mailbox_folders.mailbox_id = mailboxes.id
``` | | [workflows](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#workflows) | ```
mailbox_folders.mailbox_id = workflows.mailbox_id
``` | mailbox\_folders table schema | **active\_count**


INTEGER | | --- | | **id**


INTEGER | | **mailbox\_id**


INTEGER | | **name**


STRING | | **total\_count**


INTEGER | | **type**


STRING | | **updated\_at**


DATE-TIME | | **user\_id**


INTEGER | ### mailboxes The `mailboxes` table contains info about the mailboxes in your Help Scout account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [mailboxes schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/mailboxes.json "Opens in new tab: mailboxes schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/list/ "Opens in new tab: Help Scout API method") | mailboxes table foreign keys | Join mailboxes with | on | | --- | --- | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
mailboxes.id = conversations.mailbox_id
``` | | [mailbox_fields](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-fields) | ```
mailboxes.id = mailbox_fields.mailbox_id
``` | | [mailbox_folders](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-folders) | ```
mailboxes.id = mailbox_folders.mailbox_id
``` | | [workflows](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#workflows) | ```
mailboxes.id = workflows.mailbox_id
``` | mailboxes table schema | **created\_at**


DATE-TIME | | --- | | **email**


STRING | | **id**


INTEGER | | **name**


STRING | | **slug**


STRING | | **updated\_at**


DATE-TIME | ### team\_members This report contains information about team members. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | team\_id

user\_id | | **Useful links** | [team_members schema on GitHub](https://github.com/singer-io/tap-helpscout/tree/master/tap_helpscout/schemas/team_members.json "Opens in new tab: team_members schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/teams/list-team-members/ "Opens in new tab: Help Scout API method") | team\_members table schema | **team\_id**


INTEGER | | --- | | **user\_id**


INTEGER | ### teams This report contains information about all the different teams in the company. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [teams schema on GitHub](https://github.com/singer-io/tap-helpscout/tree/master/tap_helpscout/schemas/teams.json "Opens in new tab: teams schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/teams/list-teams/ "Opens in new tab: Help Scout API method") | teams table schema | **created\_at**


DATE-TIME | | --- | | **id**


INTEGER | | **initials**


STRING | | **mention**


STRING | | **name**


STRING | | **photo\_url**


STRING | | **timezone**


STRING | | **updated\_at**


DATE-TIME | ### users The `users` table contains info about the users in your Help Scout account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [users schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/users.json "Opens in new tab: users schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/users/list/ "Opens in new tab: Help Scout API method") | users table foreign keys | Join users with | on | | --- | --- | | [conversation_threads](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversation-threads) | ```
users.id = conversation_threads.assigned_to.id
```

```
users.id = conversation_threads.created_by.id
``` | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
users.id = conversations.assignee.id
```

```
users.id = conversations.closed_by
```

```
users.id = conversations.created_by.id
``` | users table schema | **created\_at**


DATE-TIME | | --- | | **email**


STRING | | **first\_name**


STRING | | **id**


INTEGER | | **last\_name**


STRING | | **photo\_url**


STRING | | **role**


STRING | | **timezone**


STRING | | **type**


STRING | | **updated\_at**


DATE-TIME | ### workflows The `workflows` table contains info about the workflows in your Help Scout account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | modified\_at | | **Useful links** | [workflows schema on GitHub](https://github.com/singer-io/tap-helpscout/blob/master/tap_helpscout/schemas/workflows.json "Opens in new tab: workflows schema on GitHub")


[Help Scout API method](https://developer.helpscout.com/mailbox-api/endpoints/workflows/list/ "Opens in new tab: Help Scout API method") | workflows table foreign keys | Join workflows with | on | | --- | --- | | [conversations](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#conversations) | ```
workflows.mailbox_id = conversations.mailbox_id
``` | | [mailbox_fields](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-fields) | ```
workflows.mailbox_id = mailbox_fields.mailbox_id
``` | | [mailbox_folders](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailbox-folders) | ```
workflows.mailbox_id = mailbox_folders.mailbox_id
``` | | [mailboxes](https://help.qlik.com/en-US/stitch/integrations/saas/helpscout#mailboxes) | ```
workflows.mailbox_id = mailboxes.id
``` | workflows table schema | **created\_at**


DATE-TIME | | --- | | **id**


INTEGER | | **mailbox\_id**


INTEGER | | **modified\_at**


DATE-TIME | | **name**


STRING | | **order**


INTEGER | | **status**


STRING | | **type**


STRING |