Add Customer Message
helpscout.create_customer_thread
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Add a message from the customer to a conversation, as though they had written in; the conversation reopens unless the thread is imported.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Help Scout
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- mailbox_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
conversation_id The numeric id of the conversation to act on. | string | Yes | — | — | — |
text What the customer said. | string | Yes | — | — | — |
customer_email The customer's email address; Help Scout creates the customer when no one has that address yet. | string | No | — | email format | ada@example.com |
customer The customer as a JSON object, when you have their id: {"id": 123}. | object | No | — | — | {"id":123} |
cc Email addresses to copy, as a JSON array of strings. | array | No | — | array of string | — |
bcc Email addresses to blind-copy, as a JSON array of strings. | array | No | — | array of string | — |
imported Import historical data: no notification is raised and the conversation is not reopened. | boolean | No | — | — | — |
- At least one of customer_email, customer must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"customer": {
"id": 123
},
"customer_email": "ada@example.com"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
created True once Help Scout answered 201 Created. | boolean | — |
kind Which resource was created: conversation, thread, customer or email. | string | — |
id The new resource's id, read from the Resource-ID response header. | string | — |
location The API URL of the new resource, from the Location header. | string | — |
web_location The Help Scout web URL of the new resource, when sent. | string | — |
status The HTTP status Help Scout answered with. | number | — |
conversation_id The conversation that was acted on. | string | — |
{
"conversation_id": "",
"created": false,
"id": "",
"kind": "",
"location": "",
"status": 0,
"web_location": ""
}See Add Customer Message run in a workflow.
In a technical demo we add the Help Scout connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.