> ## Documentation Index
> Fetch the complete documentation index at: https://ampersand-24eb5c1a-square-proxy.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Help Scout Mailbox

## What's Supported

### Supported Actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Helpscout instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.helpscout.net`.

### Supported Objects

The HelpscoutMailbox connector supports reading from the following objects:

* [conversations](https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/)
* [customers](https://developer.helpscout.com/mailbox-api/endpoints/customers/list/)
* [mailboxes](https://developer.helpscout.com/mailbox-api/endpoints/inboxes/list/)
* [customer-properties](https://developer.helpscout.com/mailbox-api/endpoints/properties/list/)
* [tags](https://developer.helpscout.com/mailbox-api/endpoints/tags/list/)
* [teams](https://developer.helpscout.com/mailbox-api/endpoints/teams/list-teams/)
* [users](https://developer.helpscout.com/mailbox-api/endpoints/users/list/)
* [webhooks](https://developer.helpscout.com/mailbox-api/endpoints/webhooks/list/)
* [workflows](https://developer.helpscout.com/mailbox-api/endpoints/workflows/list/)

The HelpscoutMailbox connector supports writing to the following objects:

* [conversations](https://developer.helpscout.com/mailbox-api/endpoints/conversations/create/)
* [customers](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)
* [customer-properties](https://developer.helpscout.com/mailbox-api/endpoints/properties/create/)
* [webhooks](https://developer.helpscout.com/mailbox-api/endpoints/webhooks/create/)

## Before You Get Started\*\*\*\*\*\*\*\*

To connect Help Scout Mailbox with Ampersand, you will need [a Help Scout Account](https://www.helpscout.com/).

Once your account is created, you'll need to create an app in the Help Scout developer portal, configure the app, and obtain the following credentials from your app:

* App ID
* App Secret

You will then use these credentials to connect your application to Ampersand.

### Create a Help Scout Account

Here's how you can sign up for a Help Scout account:

* Go to the [Help Scout website](https://www.helpscout.com/) and register for a new account.

### Create a Help Scout App

Follow the steps below to create a Help Scout API app:

1. Log in to your Help Scout account.
2. Navigate to the Help Scout Developer Portal.
3. From the main page, go to **Manage → My Apps → Create My App**.
4. Enter the **App Name** and **Redirection URL**.
5. Click **Create**.

   <br />

   <img src="https://mintcdn.com/ampersand-24eb5c1a-square-proxy/uJIcPIMi_VTSdhsa/images/provider-guides/ddba26c-RsGLizoLnbDCE3ichwJvAvvH.png?fit=max&auto=format&n=uJIcPIMi_VTSdhsa&q=85&s=1948d677f74fb7e04bc24c2812624815" alt="Ampersand Project Selection" width="560" height="265" data-path="images/provider-guides/ddba26c-RsGLizoLnbDCE3ichwJvAvvH.png" />

Upon creation, the app will display the necessary credentials: **Client ID (App ID)** and **Client Secret (App Secret).** Note these down, as you will need it to connect your app to Ampersand.

<br />

## Add Your Help Scout App Info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).
2. Select the project where you want to create a Help Scout integration.\\
   <img src="https://mintcdn.com/ampersand-24eb5c1a-square-proxy/ejdbQ1e8FNJV93R0/images/provider-guides/31a6a12-Ampersand.png?fit=max&auto=format&n=ejdbQ1e8FNJV93R0&q=85&s=374b703b84dc291efa7c405f7a482f6d" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/31a6a12-Ampersand.png" />
3. Select **Provider Apps**.
4. Select **Help Scout Mailbox** from the **Provider** list.
5. Enter the previously obtained **App ID** in the **Client ID** field and the **App Secret** in the **Client Secret** field.

   <img src="https://mintcdn.com/ampersand-24eb5c1a-square-proxy/ejdbQ1e8FNJV93R0/images/provider-guides/1d847cc-helpscout1.gif?s=581fc0e9241aac0b8d3b1357d8fd7e40" alt="Ampersand Project Selection" width="818" height="478" data-path="images/provider-guides/1d847cc-helpscout1.gif" />
6. Click **Save Changes**.