> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Help Scout

> How to set up the Help Scout connector, plus the actions and events that are available.

![Help Scout](https://stackone-logos.com/api/helpscout/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/helpscout/changelog.md)

[36 actions](#actions) · [28 events](#events) · 2 auth methods

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 - Client Credentials · Connector Profile](https://docs.stackone.com/connectors/helpscout/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Best for server-to-server integrations with no user interaction. Acts with app-level permissions, not tied to a user.

> [card] [OAuth 2.0 - Authorization Code · Connector Profile](https://docs.stackone.com/connectors/helpscout/guides/connector-profile/oauth-2-0-authorization-code.md)
>
> Recommended for user-facing integrations. Each user authorizes access scoped to their Help Scout permissions.

Optionally, configure receiving Events for Help Scout into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/helpscout/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 - Client Credentials · Link Account](https://docs.stackone.com/connectors/helpscout/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [OAuth 2.0 - Authorization Code · Link Account](https://docs.stackone.com/connectors/helpscout/guides/link-account/oauth-2-0-authorization-code.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0 - Authorization Code

OAuth 2.0 - Client Credentials

No auth methods found

36 actions

ActionDescription

List Conversations`helpscout_list_conversations`

Retrieve a paginated list of conversations across one or more mailboxes.

Get Conversation`helpscout_get_conversation`

Retrieve the full details of a single conversation by its ID.

Create Conversation`helpscout_create_conversation`

Create a new conversation in a mailbox with an initial thread.

Update Conversation`helpscout_update_conversation`

Apply a single JSON Patch operation to update one field of a conversation.

Delete Conversation`helpscout_delete_conversation`

Permanently delete a conversation by its ID.

List Conversation Threads`helpscout_list_conversation_threads`

Retrieve all threads (messages, notes, replies) for a conversation.

Create Reply Thread`helpscout_create_reply_thread`

Add an outgoing reply to an existing conversation.

Create Note Thread`helpscout_create_note_thread`

Add an internal note to an existing conversation.

Update Conversation Tags`helpscout_update_conversation_tags`

Replace all tags on a conversation with a new set of tags.

List Customers`helpscout_list_customers`

Retrieve a paginated list of customers with optional filters.

Get Customer`helpscout_get_customer`

Retrieve full profile details of a single customer by their ID.

Create Customer`helpscout_create_customer`

Create a new customer record in Help Scout.

Update Customer`helpscout_update_customer`

Apply one or more JSON Patch operations to update a customer record.

Delete Customer`helpscout_delete_customer`

Permanently delete a customer record by its ID.

List Customer Emails`helpscout_list_customer_emails`

Retrieve all email addresses associated with a specific customer.

List Customer Phones`helpscout_list_customer_phones`

Retrieve all phone numbers associated with a specific customer.

List Mailboxes`helpscout_list_mailboxes`

Retrieve a list of all mailboxes in the Help Scout account.

Get Mailbox`helpscout_get_mailbox`

Retrieve details of a specific mailbox by its ID.

List Mailbox Custom Fields`helpscout_list_mailbox_custom_fields`

Retrieve all custom fields configured for a mailbox.

List Mailbox Folders`helpscout_list_mailbox_folders`

Retrieve all folders within a specific mailbox.

List Mailbox Saved Replies`helpscout_list_mailbox_saved_replies`

Retrieve all saved replies for a mailbox.

Get Mailbox Saved Reply`helpscout_get_mailbox_saved_reply`

Retrieve a single saved reply by its ID.

Create Mailbox Saved Reply`helpscout_create_mailbox_saved_reply`

Create a new saved reply in a mailbox.

Update Mailbox Saved Reply`helpscout_update_mailbox_saved_reply`

Update an existing saved reply in a mailbox.

Delete Mailbox Saved Reply`helpscout_delete_mailbox_saved_reply`

Permanently delete a saved reply from a mailbox.

List Tags`helpscout_list_tags`

Retrieve a paginated list of all tags in the Help Scout account.

Get Tag`helpscout_get_tag`

Retrieve a single tag by its ID.

List Teams`helpscout_list_teams`

Retrieve a paginated list of all teams in the Help Scout account.

List Team Members`helpscout_list_team_members`

Retrieve all members of a specific team.

List Users`helpscout_list_users`

Retrieve a paginated list of all users (agents) in the Help Scout account.

Get User`helpscout_get_user`

Retrieve the full profile of a specific user by their ID.

List User Statuses`helpscout_list_user_statuses`

Retrieve the current availability status of all users in the Help Scout account.

Get User Status`helpscout_get_user_status`

Retrieve the current availability status of a specific user.

Get Current User`helpscout_get_current_user`

Retrieve the profile of the currently authenticated user or app.

List Workflows`helpscout_list_workflows`

Retrieve a paginated list of all workflows in the Help Scout account.

Run Workflow`helpscout_run_workflow`

Manually trigger a manual workflow on one or more conversations.

## Events

Tags

Select all
|
Clear

Beacon Chats

Conversations

Customers

Health Checks

Organizations

Ratings

Surveys

Tags

Users

No tags found

28 events

EventDescriptionTags

Active Check`helpscout_active_check`

Responds with 200 OK to any Help Scout delivery that carries no X-HelpScout-Event header.

Health Checks

Conversation Created`helpscout_webhook_convo_created`

Fired when a new conversation is created in a Help Scout inbox.

Conversations

Conversation Assigned`helpscout_webhook_convo_assigned`

Fired when a Help Scout conversation is assigned to a user.

Conversations

Conversation Moved`helpscout_webhook_convo_moved`

Fired when a Help Scout conversation is moved to a different inbox.

Conversations

Conversation Status Updated`helpscout_webhook_convo_status`

Fired when the status of a Help Scout conversation changes (active, pending, closed, or spam).

Conversations

Conversation Tags Updated`helpscout_webhook_convo_tags`

Fired when tags are added to or removed from a Help Scout conversation.

Conversations

Conversation Custom Fields Updated`helpscout_webhook_convo_custom_fields`

Fired when the custom field values on a Help Scout conversation are updated.

Conversations

Conversation Merged`helpscout_webhook_convo_merged`

Fired when two Help Scout conversations are merged into one.

Conversations

Customer Reply Created`helpscout_webhook_convo_customer_reply_created`

Fired when a customer adds a reply to a Help Scout conversation.

Conversations

Agent Reply Created`helpscout_webhook_convo_agent_reply_created`

Fired when a Help Scout user sends a reply on a conversation.

Conversations

Note Created`helpscout_webhook_convo_note_created`

Fired when a Help Scout user adds an internal note to a conversation.

Conversations

AI Answers Email Reply Created`helpscout_webhook_convo_ai_answers_email_reply_created`

Fired when Help Scout AI Answers sends an email reply on a conversation.

Conversations

AI Answers Email Resolution`helpscout_webhook_convo_ai_answers_email_resolution`

Fired when Help Scout AI Answers resolves an email conversation.

Conversations

Conversation Deleted`helpscout_webhook_convo_deleted`

Fired when a Help Scout conversation is deleted.

Conversations

Customer Created`helpscout_webhook_customer_created`

Fired when a new customer profile is created in Help Scout.

Customers

Customer Updated`helpscout_webhook_customer_updated`

Fired when a Help Scout customer profile is updated.

Customers

Customer Deleted`helpscout_webhook_customer_deleted`

Fired when a Help Scout customer profile is deleted.

Customers

Organization Created`helpscout_webhook_organization_created`

Fired when a Help Scout organization is created.

Organizations

Organization Updated`helpscout_webhook_organization_updated`

Fired when a Help Scout organization is updated.

Organizations

Organization Deleted`helpscout_webhook_organization_deleted`

Fired when a Help Scout organization is deleted.

Organizations

Tag Created`helpscout_webhook_tag_created`

Fired when a Help Scout tag is created.

Tags

Tag Updated`helpscout_webhook_tag_updated`

Fired when a Help Scout tag is updated.

Tags

Tag Deleted`helpscout_webhook_tag_deleted`

Fired when a Help Scout tag is deleted.

Tags

Satisfaction Rating Received`helpscout_webhook_satisfaction_ratings`

Fired when a customer submits a satisfaction rating on a Help Scout reply.

Ratings

Survey Response Received`helpscout_webhook_message_survey_response_received`

Fired when a customer responds to a Help Scout Messages survey.

Surveys

User Status Changed`helpscout_webhook_user_status_changed`

Fired when a Help Scout user's availability status changes.

Users

Beacon Chat Created`helpscout_webhook_beacon_chat_created`

Fired when a customer starts a new chat through a Help Scout Beacon.

Beacon Chats

Beacon Chat Customer Replied`helpscout_webhook_beacon_chat_customer_replied`

Fired when a customer replies in a Help Scout Beacon chat.

Beacon Chats


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.