Requirements
Connecting Help Scout takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your Help Scout credentials
Connect Help Scout in WEXTL
- Log in to your WEXTL account, add the Help Scout node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Help Scout account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Help Scout node modules
The list below is a reference of every Help Scout node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Help Scout node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch ConversationsTrigger
Watch Help Scout EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| Number | number |
| Threads | number |
| Type | text |
| Folder ID | number |
| Status | text |
| State | text |
| Subject | text |
| Preview | text |
18other output fields
Download Attachment FileSearch
Get AddressSearch
Get Attachment DataSearch
Get Chat ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Current | object |
| Start Date | date |
| End Date | date |
| Volume | object |
| Responses | object |
| Resolutions | object |
| Previous | object |
| Start Date | date |
| End Date | date |
| Volume | object |
| Responses | object |
| Resolutions | object |
| Deltas | object |
| Volume | object |
| Responses | object |
| Resolutions | object |
| Wait Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Response Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Messages Per Chat | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Duration | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
Get Company Customers Helped ReportSearch
Get Company Drilldown ReportSearch
Get Company Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| Current | object |
| Start Date | date |
| End Date | date |
| Customers Helped | number |
| Closed | number |
| Total Replies | number |
| Total Users | number |
| Total Days | number |
| Replies Per Day Per User | number |
| Replies Per Day | number |
| Resolved Per Day | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Customers Helped | number |
| Closed | number |
| Total Replies | number |
| Total Users | number |
| Total Days | number |
| Replies Per Day Per User | number |
| Replies Per Day | number |
| Resolved Per Day | number |
| Deltas | object |
| Customers Helped | number |
| Total Replies | number |
| Replies Per Day | number |
| Closed | number |
| Total Users | number |
| Replies Per Day Per User | number |
| Users | array |
Get ConversationSearch
Get Conversation ReassignmentSearch
Get Conversations Busy Times ReportSearch
Get Conversations Drilldown ReportSearch
Get Conversations Field Drilldown ReportSearch
Get Conversations Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| Busiest Day | object |
| Day | number |
| Hour | number |
| Count | number |
| Busy Time Start | number |
| Busy Time End | number |
| Current | object |
| Start Date | date |
| End Date | date |
| Total Conversations | number |
| Conversations Created | number |
| New Conversations | number |
| Customers | number |
| Conversations Per Day | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Total Conversations | number |
| Conversations Created | number |
| New Conversations | number |
| Customers | number |
| Conversations Per Day | number |
| Deltas | object |
| New Conversations | number |
| Total Conversations | number |
| Customers | number |
| Conversations Created | number |
| Conversations Per Day | number |
| Tags | object |
| Count | number |
| Top | array |
| Customers | object |
| Count | number |
| Top | array |
3other output fields
Get CustomerSearch
Get Docs Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Current | object |
| Visitors | number |
| Browse Action | number |
| Sent An Email Result | number |
| Found An Answer Result | number |
| Search Action | number |
| Failed Result | number |
| Docs Viewed Per Visit | number |
| Popular Searches | array |
| Failed Searches | array |
| Top Articles | array |
| Top Categories | array |
| Deltas | object |
| Failed Result | number |
| Docs Viewed Per Visit | number |
| Found An Answer Result | number |
| Visitors | number |
| Browse Action | number |
| Search Action | number |
| Sent An Email Result | number |
Get Email ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| Current | object |
| Start Date | date |
| End Date | date |
| Volume | object |
| Resolutions | object |
| Responses | object |
| Previous | object |
| Start Date | date |
| End Date | date |
| Volume | object |
| Resolutions | object |
| Responses | object |
| Deltas | object |
| Volume | object |
| Resolutions | object |
| Responses | object |
| Response Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Handle Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| First Response Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Resolution Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Replies To Resolve | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
Get First Response Time ReportSearch
Get Happiness Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Current | object |
| Ratings Percent | number |
| Okay | number |
| Great | number |
| Happiness Score | number |
| Okay Count | number |
| Total Customers With Ratings | number |
| Not Good Count | number |
| Ratings Count | number |
| Not Good | number |
| Great Count | number |
| Previous | object |
| Ratings Percent | number |
| Great | number |
| Okay | number |
| Happiness Score | number |
| Okay Count | number |
| Total Customers With Ratings | number |
| Not Good Count | number |
| Ratings Count | number |
| Not Good | number |
| Great Count | number |
| Deltas | object |
| Okay | number |
| Great | number |
| Okay Count | number |
| Happiness Score | number |
| Not Good Count | number |
| Not Good | number |
| Great Count | number |
Get Happiness Ratings ReportSearch
Get InboxSearch
Get New Conversations Drilldown ReportSearch
Get New Conversations ReportSearch
Get OrganizationSearch
Get Organization Property DefinitionSearch
Get Phone ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Current | object |
| Start Date | date |
| End Date | date |
| Phone Conversations | number |
| Phone Calls Created | number |
| Customers | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Phone Conversations | number |
| Phone Calls Created | number |
| Customers | number |
| Deltas | object |
| New Conversations | number |
| Phone Calls Created | number |
| Customers | number |
| Users | array |
Get Productivity Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| Current | object |
| Start Date | date |
| End Date | date |
| Total Conversations | number |
| Resolution Time | number |
| Replies To Resolve | number |
| Response Time | number |
| First Response Time | number |
| Resolved | number |
| Resolved On First Reply | number |
| Closed | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Total Conversations | number |
| Resolution Time | number |
| Replies To Resolve | number |
| Response Time | number |
| First Response Time | number |
| Resolved | number |
| Resolved On First Reply | number |
| Closed | number |
| Deltas | object |
| Total Conversations | number |
| Replies Sent | number |
| First Response Time | number |
| Resolved | number |
| Replies To Resolve | number |
| Closed | number |
| Resolved On First Reply | number |
| Response Time | number |
| Handle Time | number |
| Resolution Time | number |
| Response Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Handle Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| First Response Time | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
| Replies To Resolve | object |
| Count | number |
| Previous Count | number |
| Ranges | array |
Get Received Messages ReportSearch
Get Replies Sent ReportSearch
Get Resolution Time ReportSearch
Get Resolved ReportSearch
Get Resource OwnerSearch
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| First Name | text |
| Last Name | text |
| text | |
| Role | text |
| Timezone | text |
| Photo Url | text |
| Created At | date |
| Updated At | date |
8other output fields
Get Response Time ReportSearch
Get Routing ConfigurationSearch
Get Satisfaction RatingSearch
Input fields[3]
| Field | Type |
|---|---|
IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| Customer | object |
| Id | number |
| text | |
| First Name | text |
| Last Name | text |
| Photo Url | text |
| Thread ID | number |
| Conversation ID | number |
| Conversation Number | number |
| Mailbox ID | number |
| Rating | text |
| User | object |
| Id | number |
| text | |
| First Name | text |
| Last Name | text |
| Comments | text |
1other output field
Get Saved ReplySearch
Get System UserSearch
Get TagSearch
Get Thread Original SourceSearch
Get Thread Original Source as RFC 822Search
Get UserSearch
Get User Chat ReportSearch
Input fields[3]
| Field | Type |
|---|---|
UserRequired | choice |
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Current | object |
| Start Date | date |
| End Date | date |
| Total Days | number |
| New Conversations | number |
| Messages Per Chat | number |
| Response Time | number |
| Wait Time | number |
| Duration | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Total Days | number |
| New Conversations | number |
| Messages Per Chat | number |
| Response Time | text |
| Wait Time | text |
| Duration | text |
| Deltas | object |
| New Conversations | number |
| Messages Per Chat | number |
| Response Time | number |
| Wait Time | number |
| Duration | number |
Get User Conversation History ReportSearch
Get User Customers Helped ReportSearch
Get User Drilldown ReportSearch
Get User Happiness Drilldown ReportSearch
Get User Happiness ReportSearch
Input fields[3]
| Field | Type |
|---|---|
UserRequired | choice |
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| Current | object |
| Ratings Percent | number |
| Okay | number |
| Great | number |
| Happiness Score | number |
| Okay Count | number |
| Total Customers With Ratings | number |
| Not Good Count | number |
| Ratings Count | number |
| Not Good | number |
| Great Count | number |
| Previous | object |
| Ratings Percent | number |
| Great | number |
| Okay | number |
| Happiness Score | number |
| Okay Count | number |
| Total Customers With Ratings | number |
| Not Good Count | number |
| Ratings Count | number |
| Not Good | number |
| Great Count | number |
| Deltas | object |
| Okay | number |
| Great | number |
| Okay Count | number |
| Happiness Score | number |
| Not Good Count | number |
| Not Good | number |
| Great Count | number |
Get User Overall ReportSearch
Input fields[3]
| Field | Type |
|---|---|
UserRequired | choice |
StartRequired | date |
EndRequired | date |
| Inbox | choice |
Output fields[3]
| Field | Type |
|---|---|
| Filter Tags | array |
| User | object |
| Id | number |
| Has Photo | boolean |
| Created At | date |
| Name | text |
| Total Customers Helped | number |
| Photo Url | text |
| Current | object |
| Start Date | date |
| End Date | date |
| Total Days | number |
| Resolved | number |
| Conversations Created | number |
| Closed | number |
| Total Replies | number |
| Resolved On First Reply | number |
| Percent Resolved On First Reply | number |
| Replies To Resolve | number |
| Previous | object |
| Start Date | date |
| End Date | date |
| Total Days | number |
| Resolved | number |
| Conversations Created | number |
| Closed | number |
| Total Replies | number |
| Resolved On First Reply | number |
| Percent Resolved On First Reply | number |
| Replies To Resolve | number |
| Deltas | object |
| Total Conversations | number |
| Customers Helped | number |
| Happiness Score | number |
| Replies Per Day | number |
| Resolved On First Reply | number |
| Handle Time | number |
| Conversations Per Day | number |
| Resolved | number |
| Replies To Resolve | number |
| Active Conversations | number |
Get User Replies ReportSearch
Get User Resolutions ReportSearch
Get User StatusSearch
Get Volume by Channel ReportSearch
List Chat HandlesSearch
List ConversationsSearch
List Customer Property DefinitionsSearch
List CustomersSearch
List EmailsSearch
List Inbox Custom FieldsSearch
List Inbox FoldersSearch
List InboxesSearch
List Organization ConversationsSearch
List Organization CustomersSearch
List Organization Property DefinitionsSearch
List OrganizationsSearch
List PhonesSearch
List Saved RepliesSearch
List Social ProfilesSearch
List System UsersSearch
List TagsSearch
List Team MembersSearch
List TeamsSearch
List ThreadsSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| Type | text |
| Status | text |
| State | text |
| Action | object |
| Type | text |
| Text | text |
| Body | text |
| Source | object |
| Type | text |
| Via | text |
| Customer | object |
| Id | number |
| First | text |
| Last | text |
| Photo Url | text |
| text | |
| Created By | object |
| Id | number |
| Type | text |
| First | text |
| Last | text |
| Photo Url | text |
| text |
10other output fields
List User StatusesSearch
List UsersSearch
List WebsitesSearch
List WorkflowsSearch
Create AddressAction
Create Chat HandleAction
Create Chat ThreadAction
Create ConversationAction
Input fields[3]
| Field | Type |
|---|---|
SubjectRequired | text |
TypeRequired | choice |
InboxRequired | choice |
StatusRequired | choice |
CustomerRequired | object |
| ID | number |
| text | |
| First Name | text |
| Last Name | text |
ThreadsRequired | array |
| Auto Reply | boolean |
| Imported | boolean |
| Assign To | choice |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| Subject | text |
| Mailbox ID | number |
| Type | text |
| Status | text |
Create CustomerAction
Create Customer Property DefinitionAction
Create Customer ThreadAction
Create EmailAction
Create NoteAction
Create OrganizationAction
Create Organization Property DefinitionAction
Create PhoneAction
Create Phone ThreadAction
Create Reply ThreadAction
Create Saved ReplyAction
Create Social ProfileAction
Create UserAction
Create WebsiteAction
Delete AttachmentAction
Delete Chat HandleAction
Delete Customer AsynchronouslyAction
Delete Customer Property DefinitionAction
Delete EmailAction
Delete Organization Property DefinitionAction
Delete PhoneAction
Delete Saved ReplyAction
Delete Social ProfileAction
Delete Thread ScheduleAction
Delete WebsiteAction
Make an API Calluniversal
Overwrite CustomerAction
Publish Thread ScheduleAction
Remove Organization Property ValueAction
Run Manual WorkflowAction
Set Organization Property ValueAction
Set User StatusAction
Update AddressAction
Update Chat HandleAction
Update ConversationAction
Update Conversation Custom FieldsAction
Update Conversation ReassignmentAction
Update Conversation TagsAction
Update CustomerAction
Update Customer PropertiesAction
Update EmailAction
Update OrganizationAction
Update Organization Property DefinitionAction
Update PhoneAction
Update Routing ConfigurationAction
Update Saved ReplyAction
Update SnoozeAction
Update Social ProfileAction
Update Team MembersAction
Update ThreadAction
Input fields[3]
| Field | Type |
|---|---|
ConversationRequired | choice |
ThreadRequired | choice |
OperationsRequired | array |
Output fields[3]
| Field | Type |
|---|---|
| Id | number |
| Type | text |
| Status | text |
| State | text |
| Action | object |
| Type | text |
| Text | text |
| Body | text |
| Source | object |
| Type | text |
| Via | text |
| Customer | object |
| Id | number |
| First | text |
| Last | text |
| Photo Url | text |
| text | |
| Created By | object |
| Id | number |
| Type | text |
| First | text |
| Last | text |
| Photo Url | text |
| text |
10other output fields
Update Thread ScheduleAction
Update WebsiteAction
Update WorkflowAction
Templates
Look for Help Scout templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Clio Manage[2]Manage matters, contacts, tasks, billing, documents, and calendars in Clio Manage legal practice management.
- Clio GrowManage contacts, matters, inbox leads, lead sources, and locations in Clio Grow client intake.
- DaySmart VetCloud veterinary practice management for scheduling, records, and client communication.
- CharmHealthCloud EHR for patients, appointments, encounters, and clinical records.
- ChatwootOpen-source customer engagement platform for shared inboxes, live chat, and support workflows.
References
- WEXTL® Help Scout Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Help Scout.
- WEXTL® visual workflow builder data.
Last updated: Aug 28, 2026 21:55