Help Scout
Read and write Help Scout conversations, threads, replies, notes and customers, plus mailboxes, users, tags, workflows and ratings.
Keep shared-mailbox conversations and customer profiles aligned with CRM, commerce and success tools.
Source actions
11
Destination actions
8
Data types
13
Validation status
Implemented · fixture tested.
Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.
What you can map
conversation fields
- Set conversation custom fieldsDestinationDuplicate protected
Sets mailbox custom field values on a conversation.
conversation tags
- Set conversation tagsDestinationDuplicate protected
Replaces the tags on a conversation.
conversations
- Create conversationDestinationNot retried automatically
Creates a conversation with a first customer message, reply or note thread.
- Get conversationSource
A conversation with embedded threads and custom fields.
- List conversationsSourceIncremental
Conversations in all statuses, oldest modification first when filtered.
- Update conversationDestinationDuplicate protected
Changes status, subject, assignee, mailbox or primary customer (one change per request).
customers
- Create customerDestinationNot retried automatically
Creates a customer with emails and phones.
- Get customerSource
A customer with emails, phones and profile details.
- List customersSourceIncremental
Customers with emails and phones, oldest modification first when filtered.
- Update customerDestinationDuplicate protected
Replaces profile fields on a customer with JSON Patch operations.
mailbox fields
- List mailbox custom fieldsSource
Custom field definitions of a mailbox with options.
mailboxes
- List mailboxesSource
Mailboxes (inboxes) the app user can access.
notes
- Add noteDestinationNot retried automatically
Adds an internal note to a conversation.
replies
- Reply to conversationDestinationNot retried automatically
Emails a reply to the customer on a conversation.
satisfaction ratings
- List satisfaction ratingsSource
Happiness ratings with comments, customer and rated user in a period.
tags
- List tagsSource
Tags with usage counts.
threads
- List threadsSource
Customer messages, replies, notes and line items in a conversation.
users
- List usersSource
Help Scout users (agents) with role and timezone.
workflows
- List workflowsSource
Automatic and manual workflows with status and mailbox.
Authentication
OAuth app ID and secret (client credentials)
Plans and access
All Help Scout plans include the Mailbox API; happiness rating reports need Plus or Pro. Client-credentials apps act as the Help Scout user who created the app and see that user's mailboxes.
Test environment
Help Scout free trials can be used for testing.
Rate limits
200–800 requests per minute by plan, with write requests weighted; HTTP 429 with X-RateLimit-Retry-After.
Provider events
Help Scout webhooks for conversation, customer and rating events. Nexra event triggers are not yet available; flows run on demand or on a schedule.
Before you build a flow
- Conversation and customer deletion are not implemented.
- Conversation updates apply one change per request, as the Help Scout JSON Patch endpoint requires.
- Conversations created with a reply thread email the customer unless imported is set.
- Help Scout documents no idempotency key: conversation, reply, note and customer creates are not repeated automatically when uncertain.
- Satisfaction ratings come from the happiness ratings report (Plus and Pro plans).
- Merged conversations answer with HTTP 301; Nexra does not follow redirects.