Subscribe to Help Scout events (convo.created, convo.assigned, convo.tag, customer.created, rating.received) for downstream automation. Webhooks include HMAC signatures for verification.
Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.
Channels 1
PUB
/webhook
Receive a Help Scout webhook event
receiveHelpScoutWebhookbody
Messages & Schemas 35
The contract defines 35 schemas that model the data carried by its messages. The most detailed are Conversation (25 properties), Customer (21 properties), Rating (15 properties), BeaconChat (8 properties). Each schema is shown below with its type and property counts.
ConvoAssigned
message
Fired when a conversation is assigned to a Help Scout user or team.
ConvoCreated
message
Fired when a new conversation is created in a Help Scout mailbox.
ConvoAiAnswersCreated
message
Fired when a conversation is created by Help Scout AI Answers.
ConvoDeleted
message
Fired when a conversation is deleted. Payload contains only the deleted conversation identifier.
ConvoMerged
message
Fired when two conversations are merged into one.
ConvoMoved
message
Fired when a conversation is moved between Help Scout mailboxes.
ConvoStatus
message
Fired when a conversation's status changes, e.g. active, pending, closed, spam.
ConvoTags
message
Fired when tags on a conversation are added or removed.
ConvoCustomFields
message
Fired when custom field values on a conversation are updated.
ConvoCustomerReplyCreated
message
Fired when a customer replies to a conversation, creating a new customer thread.
ConvoAgentReplyCreated
message
Fired when a Help Scout user (agent) replies to a conversation, creating a new agent thread.
ConvoNoteCreated
message
Fired when an internal note is added to a conversation.
CustomerCreated
message
Fired when a new customer record is created. Triggers globally and is not filterable by inbox.
CustomerUpdated
message
Fired when a customer record is updated, including profile fields, emails, phones, social profiles, addresses, or properties.
CustomerDeleted
message
Fired when a customer record is deleted. Payload contains only the deleted customer identifier.
SatisfactionRatings
message
Fired when a customer submits a satisfaction rating (great, okay, not good) on a conversation thread.
BeaconChatCreated
message
Fired when a new Beacon live chat session is started by a visitor.
BeaconChatCustomerReplied
message
Fired when a customer sends a new message in a Beacon chat session.
TagCreated
message
Fired when a new tag is created in the Help Scout account.
TagUpdated
message
Fired when an existing tag's name or color is updated.
TagDeleted
message
Fired when a tag is deleted. Payload contains only the deleted tag identifier.
MessageSurveyResponseReceived
message
Fired when a customer submits a response to a Help Scout message survey.
OrganizationCreated
message
Fired when a new organization is created in the Help Scout account.
OrganizationUpdated
message
Fired when an organization record is updated.
OrganizationDeleted
message
Fired when an organization is deleted. Payload contains only the deleted organization identifier.
UserStatusChanged
message
Fired when a Help Scout user's online/offline status changes.
Conversation
object
Help Scout Mailbox API v2 Conversation resource as delivered in webhook payloads for convo. events. Field set mirrors the Conversations resource of the Mailbox…
25 properties
Customer
object
Help Scout Mailbox API v2 Customer resource as delivered in webhook payloads for customer.created and customer.updated events.
21 properties
Rating
object
Help Scout Mailbox API v2 Rating resource as delivered in webhook payloads for satisfaction.ratings events.
15 properties
BeaconChat
object
Beacon live chat session payload delivered for beacon.chat.created and beacon.chat.customer.replied events.
8 properties
Tag
object
Help Scout Mailbox API v2 Tag resource delivered for tag.created and tag.updated events.
8 properties
SurveyResponse
object
Survey response payload delivered for the message.survey.response.received event. Fields reflect the message survey product and the responding customer.
6 properties
Organization
object
Organization resource delivered for organization.created and organization.updated events.
6 properties
UserStatus
object
Payload delivered for user.status.changed events when a Help Scout user goes online or offline.
6 properties
DeletedResource
object
Minimal payload delivered for .deleted events. Contains only the identifier of the removed resource.
1 property
Specification
The full machine-readable AsyncAPI contract behind this narrative.
