Add Note to Help Scout Conversation

Adds an internal note to an existing Help Scout conversation.

Unverified

Add this first. This tool needs an access token, so add Get Help Scout Access Token to the same bot. The bot calls it first and passes the token in.

What the model is told

Get a Help Scout access token first if you do not already have one. Add an internal note to an existing conversation, for example to record extra detail the customer has just given. Confirm the conversation ID and wording first. The note is only visible to the team. A successful call returns no body.

Request

POSThttps://api.helpscout.net/v2/conversations/{{conversationId}}/notes

Headers

Content-Typeapplication/json
AuthorizationBearer {{accessToken}}

Body

{
  "text": "{{note}}"
}

Parameters

conversationId stringThe Help Scout conversation ID (not the conversation number).
note stringThe text of the note.
accessToken stringThe access_token value returned by Get Help Scout Access Token. Reuse it for the rest of the conversation.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "afd50595-d6f0-4759-a5a1-25b2f4533005",
    "type": "HTTP_REQUEST",
    "label": "Add Note to Help Scout Conversation",
    "name": "add_note_to_help_scout_conversation",
    "customName": false,
    "description": "Get a Help Scout access token first if you do not already have one. Add an internal note to an existing conversation, for example to record extra detail the customer has just given. Confirm the conversation ID and wording first. The note is only visible to the team. A successful call returns no body.",
    "parameters": [
      {
        "name": "conversationId",
        "type": "string",
        "description": "The Help Scout conversation ID (not the conversation number)."
      },
      {
        "name": "note",
        "type": "string",
        "description": "The text of the note."
      },
      {
        "name": "accessToken",
        "type": "string",
        "description": "The access_token value returned by Get Help Scout Access Token. Reuse it for the rest of the conversation."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://api.helpscout.net/v2/conversations/{{conversationId}}/notes"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": "{\n  \"text\": \"{{note}}\"\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.