Connectors / Service / Help Scout

Artisan IMG > Help Scout (help-scout)

Help Scout

Directory as a service



To create an authentication with Help Scout, click on the New Authentication button and enter the same username and password used to login to your Help Scout account.

Example 1 - List Customers

In this example we'll retrieve a list of customers, using some filters and also using the advance query field.

The List operations in the Help Scout connector limit results to 50 items. To retrieve more results, the Page property needs to be used to paginate through the result set if there are more than 50.

For more information on pagination, please refer to our pagination help page here.

Step 1 - Populate filters

There are a standard set of filters in the List customers operation, including a query option for more advanced querying.

For example, customers can be filtered by Mailbox by choosing the mailbox name from the drop down. We can also return all records that have been modified after a certain date. Results can then sorted by a different fields (we'll choose modified at in this example).

Filter and sort fields

Step 2 - Populate advanced query

In addition to these filters, the Advance query property can also be used to apply more specific conditions. For example, if we wanted all customers where the email is or, AND the phone number is 01234567890, our query input would look like the below.

Advanced query email

Notice how the Conjunction is set to AND. This dictates how the field filters are logically combined. Options are AND or OR.

Advanced query phone

Step 3 - Results

Each result set will contain some properties that give information about how many items were returned, and if there are any more items to retrieve from Help Scout (see below).

Pagination information

You can see that the size property shows that 50 customers were returned, but the total number of customers is 110. Meaning we would need to make the request again and specify 2 in the Page property.

Example 2 - Create conversation

To create a conversation, at least one thread needs to be added. If only one thread is specified, this cannot be a note thread.

Step 1 - Populate required fields

Choose the type of conversation you want to create i.e. chat, email or phone. Then populate the required fields, including the customer ID associated with the conversation.

Step 2 - Add a thread

At least one thread is required, and there are different types of threads (having only one note thread is not allowed). Here we'll add a chat thread.

The Imported option is for those situations when the chat, phone call or email activity has already occurred, and you just want to make a record of it. Ticking the imported option allows you to set a historical Created at date of when the contact happened.

Attachments can also be uploaded, this requires a file object which has been generated by another connector step e.g. the Google Drive connector. This can be achieved by JSON pathing in the file object (shown below).

Please refer to our help pages on using the connector snake here, which will help create the JSON path for the file object.

JSON path attachment

Step 3 - Result

If successful, the result will be the ID of the created conversation.

All Operations

Latest version:


Get conversation

Retrieve a single conversation

Create customer

Create a new customer

Create note

Create a new note thread on a conversation

Delete conversation

Delete a conversation

List customers

Retrieve a list of customers

List mailboxes

Retrieve a list of mailboxes

List tags

Retrieve a list of tags used across all mailboxes

List threads

Retrieve a list of threads for a conversation

List users

Retrieve a list of user

Update address

Update an existing address for a customer

Update chat

Update an existing chat handle for a customer

Update conversation

Update an existing conversation. Only one field can be updated at a time.

Update customer

Update an existing customer

Update email

Update an existing email for a customer

Update phone

Update an existing phone number for a customer

Update thread

Update an existing thread. Only thread text can be updated at this time.

List conversations

Retrieve a list of conversations

Create conversation

Create a new conversation

Get customer

Retrieve a customer by their ID

Get user

Retrieve a single user by their ID

Update social profile

Update an existing social profile for a customer

Update tags

Update an existing customer