Add Note
helpscout.create_note
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Add an internal note to a conversation; the customer never sees it and no email is sent.
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
5 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 The note body; Help Scout accepts HTML here. | string | Yes | — | — | — |
user_id The Help Scout user id the note is added as; defaults to the credential's owner. | string | No | — | — | — |
status Move the conversation to this status as the note is added. | string | No | — | one of "active", "closed", "inbox_predefined", "open", "pending", "spam" | — |
imported Import historical data: no notification is raised for the note. | boolean | No | — | — | — |
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 Note 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.