Skip to main content
Help Scout
v1.2.0
36 actions · 28 events · 2 auth methods
Customer SupportTicketing

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 - Client Credentials

Best for server-to-server integrations with no user interaction. Acts with app-level permissions, not tied to a user.

Connector Profile · OAuth 2.0 - Authorization Code

Recommended for user-facing integrations. Each user authorizes access scoped to their Help Scout permissions.
Optionally, configure receiving Events for Help Scout into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 - Client Credentials

Link Account · OAuth 2.0 - Authorization Code

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
36 actions
Action
Description
List Conversations
Retrieve a paginated list of conversations across one or more mailboxes.
Get Conversation
Retrieve the full details of a single conversation by its ID.
Create Conversation
Create a new conversation in a mailbox with an initial thread.
Update Conversation
Apply a single JSON Patch operation to update one field of a conversation.
Delete Conversation
Permanently delete a conversation by its ID.
List Conversation Threads
Retrieve all threads (messages, notes, replies) for a conversation.
Create Reply Thread
Add an outgoing reply to an existing conversation.
Create Note Thread
Add an internal note to an existing conversation.
Update Conversation Tags
Replace all tags on a conversation with a new set of tags.
List Customers
Retrieve a paginated list of customers with optional filters.
Get Customer
Retrieve full profile details of a single customer by their ID.
Create Customer
Create a new customer record in Help Scout.
Update Customer
Apply one or more JSON Patch operations to update a customer record.
Delete Customer
Permanently delete a customer record by its ID.
List Customer Emails
Retrieve all email addresses associated with a specific customer.
List Customer Phones
Retrieve all phone numbers associated with a specific customer.
List Mailboxes
Retrieve a list of all mailboxes in the Help Scout account.
Get Mailbox
Retrieve details of a specific mailbox by its ID.
List Mailbox Custom Fields
Retrieve all custom fields configured for a mailbox.
List Mailbox Folders
Retrieve all folders within a specific mailbox.
List Mailbox Saved Replies
Retrieve all saved replies for a mailbox.
Get Mailbox Saved Reply
Retrieve a single saved reply by its ID.
Create Mailbox Saved Reply
Create a new saved reply in a mailbox.
Update Mailbox Saved Reply
Update an existing saved reply in a mailbox.
Delete Mailbox Saved Reply
Permanently delete a saved reply from a mailbox.
List Tags
Retrieve a paginated list of all tags in the Help Scout account.
Get Tag
Retrieve a single tag by its ID.
List Teams
Retrieve a paginated list of all teams in the Help Scout account.
List Team Members
Retrieve all members of a specific team.
List Users
Retrieve a paginated list of all users (agents) in the Help Scout account.
Get User
Retrieve the full profile of a specific user by their ID.
List User Statuses
Retrieve the current availability status of all users in the Help Scout account.
Get User Status
Retrieve the current availability status of a specific user.
Get Current User
Retrieve the profile of the currently authenticated user or app.
List Workflows
Retrieve a paginated list of all workflows in the Help Scout account.
Run Workflow
Manually trigger a manual workflow on one or more conversations.

​
Events

|
28 events
Event
Description
Tags
Active Check
Responds with 200 OK to any Help Scout delivery that carries no X-HelpScout-Event header.
Health Checks
Conversation Created
Fired when a new conversation is created in a Help Scout inbox.
Conversations
Conversation Assigned
Fired when a Help Scout conversation is assigned to a user.
Conversations
Conversation Moved
Fired when a Help Scout conversation is moved to a different inbox.
Conversations
Conversation Status Updated
Fired when the status of a Help Scout conversation changes (active, pending, closed, or spam).
Conversations
Conversation Tags Updated
Fired when tags are added to or removed from a Help Scout conversation.
Conversations
Conversation Custom Fields Updated
Fired when the custom field values on a Help Scout conversation are updated.
Conversations
Conversation Merged
Fired when two Help Scout conversations are merged into one.
Conversations
Customer Reply Created
Fired when a customer adds a reply to a Help Scout conversation.
Conversations
Agent Reply Created
Fired when a Help Scout user sends a reply on a conversation.
Conversations
Note Created
Fired when a Help Scout user adds an internal note to a conversation.
Conversations
AI Answers Email Reply Created
Fired when Help Scout AI Answers sends an email reply on a conversation.
Conversations
AI Answers Email Resolution
Fired when Help Scout AI Answers resolves an email conversation.
Conversations
Conversation Deleted
Fired when a Help Scout conversation is deleted.
Conversations
Customer Created
Fired when a new customer profile is created in Help Scout.
Customers
Customer Updated
Fired when a Help Scout customer profile is updated.
Customers
Customer Deleted
Fired when a Help Scout customer profile is deleted.
Customers
Organization Created
Fired when a Help Scout organization is created.
Organizations
Organization Updated
Fired when a Help Scout organization is updated.
Organizations
Organization Deleted
Fired when a Help Scout organization is deleted.
Organizations
Tag Created
Fired when a Help Scout tag is created.
Tags
Tag Updated
Fired when a Help Scout tag is updated.
Tags
Tag Deleted
Fired when a Help Scout tag is deleted.
Tags
Satisfaction Rating Received
Fired when a customer submits a satisfaction rating on a Help Scout reply.
Ratings
Survey Response Received
Fired when a customer responds to a Help Scout Messages survey.
Surveys
User Status Changed
Fired when a Help Scout user’s availability status changes.
Users
Beacon Chat Created
Fired when a customer starts a new chat through a Help Scout Beacon.
Beacon Chats
Beacon Chat Customer Replied
Fired when a customer replies in a Help Scout Beacon chat.
Beacon Chats