Create Conversation
helpscout.create_conversation
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Create a conversation in an inbox with its first thread, for a customer named by id or by email address.
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
13 fields, 1 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 |
|---|---|---|---|---|---|
subject The conversation's subject line. | string | Yes | — | — | — |
type What kind of conversation this is; Help Scout requires one of these. | string | No | one of "chat", "email", "phone" | — | |
status The status the new conversation starts in. | string | No | active | one of "active", "closed", "pending" | — |
mailbox_id The numeric inbox id to use instead of the connection's default inbox. | string | No | — | — | — |
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} |
text The body of the first thread, when you do not want to build the threads array yourself. | string | No | — | — | Hello — thanks for writing in. |
thread_type Which kind of thread the text becomes. | string | No | customer | one of "customer", "reply", "note", "phone", "chat" | — |
threads The full threads array to send, when one text body is not enough; each entry needs a type. | array | No | — | array of object | — |
tags Tag names to put on the new conversation, as a JSON array of strings. | array | No | — | array of string | — |
assign_to The Help Scout user or team id to assign the conversation to. | string | No | — | — | — |
imported Import historical data: Help Scout sends no email and raises no notification for the new conversation. | boolean | No | — | — | — |
auto_reply Send the inbox's auto-reply to the customer. | boolean | No | — | — | — |
- At least one of customer_email, customer must be set.
- At least one of text, threads 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",
"status": "active",
"text": "Hello — thanks for writing in.",
"thread_type": "customer",
"type": "email"
}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 | — |
{
"created": false,
"id": "",
"kind": "",
"location": "",
"status": 0,
"web_location": ""
}Notes
- Help Scout answers a create with 201 and an empty body; the new conversation id arrives in the Resource-ID header and is returned as id.
See Create Conversation 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.