AsyncAPI channel · Help Scout
· Help Scout Webhooks
/webhook
Outbound webhook channel. Help Scout posts a JSON event payload to the registered subscriber URL whenever a subscribed event occurs. The event name is carried in the X-HelpScout-Event header and the request body is signed with HMAC-SHA1 using the subscriber's shared secret. The signature is delivered in the X-HelpScout-Signature header as a base64 string.
Provider:Help ScoutAsyncAPI: v2.6.0Spec: Help Scout WebhooksOperations: 1Messages: 26
Channel address
/webhook
Operations
publish
receiveHelpScoutWebhook
Receive a Help Scout webhook event
Messages
convoAssigned
Fired when a conversation is assigned to a Help Scout user or team.
Content-Type: application/json
convoCreated
Fired when a new conversation is created in a Help Scout mailbox.
Content-Type: application/json
convoAiAnswersCreated
Fired when a conversation is created by Help Scout AI Answers.
Content-Type: application/json
convoDeleted
Fired when a conversation is deleted. Payload contains only the deleted conversation identifier.
Content-Type: application/json
convoMerged
Fired when two conversations are merged into one.
Content-Type: application/json
convoMoved
Fired when a conversation is moved between Help Scout mailboxes.
Content-Type: application/json
convoStatus
Fired when a conversation's status changes, e.g. active, pending, closed, spam.
Content-Type: application/json
convoTags
Fired when tags on a conversation are added or removed.
Content-Type: application/json
convoCustomFields
Fired when custom field values on a conversation are updated.
Content-Type: application/json
convoCustomerReplyCreated
Fired when a customer replies to a conversation, creating a new customer thread.
Content-Type: application/json
convoAgentReplyCreated
Fired when a Help Scout user (agent) replies to a conversation, creating a new agent thread.
Content-Type: application/json
convoNoteCreated
Fired when an internal note is added to a conversation.
Content-Type: application/json
customerCreated
Fired when a new customer record is created. Triggers globally and is not filterable by inbox.
Content-Type: application/json
customerUpdated
Fired when a customer record is updated, including profile fields, emails, phones, social profiles, addresses, or properties.
Content-Type: application/json
customerDeleted
Fired when a customer record is deleted. Payload contains only the deleted customer identifier.
Content-Type: application/json
satisfactionRatings
Fired when a customer submits a satisfaction rating (great, okay, not good) on a conversation thread.
Content-Type: application/json
beaconChatCreated
Fired when a new Beacon live chat session is started by a visitor.
Content-Type: application/json
beaconChatCustomerReplied
Fired when a customer sends a new message in a Beacon chat session.
Content-Type: application/json
tagCreated
Fired when a new tag is created in the Help Scout account.
Content-Type: application/json
tagUpdated
Fired when an existing tag's name or color is updated.
Content-Type: application/json
tagDeleted
Fired when a tag is deleted. Payload contains only the deleted tag identifier.
Content-Type: application/json
messageSurveyResponseReceived
Fired when a customer submits a response to a Help Scout message survey.
Content-Type: application/json
organizationCreated
Fired when a new organization is created in the Help Scout account.
Content-Type: application/json
organizationUpdated
Fired when an organization record is updated.
Content-Type: application/json
organizationDeleted
Fired when an organization is deleted. Payload contains only the deleted organization identifier.
Content-Type: application/json
userStatusChanged
Fired when a Help Scout user's online/offline status changes.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.