Create Help Scout Conversation

Starts a new email conversation in a Help Scout mailbox for a customer.

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. Create a new conversation for the customer. Confirm their email, a short subject and the detail of the issue first. A successful call returns no body: the new conversation ID is in the Resource-ID response header. Tell the customer their request has been logged.

Request

POSThttps://api.helpscout.net/v2/conversations

Headers

Content-Typeapplication/json
AuthorizationBearer {{accessToken}}

Body

{
  "subject": "{{subject}}",
  "customer": {
    "email": "{{email}}"
  },
  "mailboxId": "YOUR_HELPSCOUT_MAILBOX_ID",
  "type": "email",
  "status": "active",
  "threads": [
    {
      "type": "customer",
      "customer": {
        "email": "{{email}}"
      },
      "text": "{{message}}"
    }
  ]
}

Parameters

subject stringA short summary of the issue.
email stringThe customer's email address.
message stringThe customer's message with the detail of the issue.
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": "11e893d7-acb9-49dc-aad5-237f537d59c1",
    "type": "HTTP_REQUEST",
    "label": "Create Help Scout Conversation",
    "name": "create_help_scout_conversation",
    "customName": false,
    "description": "Get a Help Scout access token first if you do not already have one. Create a new conversation for the customer. Confirm their email, a short subject and the detail of the issue first. A successful call returns no body: the new conversation ID is in the Resource-ID response header. Tell the customer their request has been logged.",
    "parameters": [
      {
        "name": "subject",
        "type": "string",
        "description": "A short summary of the issue."
      },
      {
        "name": "email",
        "type": "string",
        "description": "The customer's email address."
      },
      {
        "name": "message",
        "type": "string",
        "description": "The customer's message with the detail of the issue."
      },
      {
        "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"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": "{\n  \"subject\": \"{{subject}}\",\n  \"customer\": {\n    \"email\": \"{{email}}\"\n  },\n  \"mailboxId\": \"YOUR_HELPSCOUT_MAILBOX_ID\",\n  \"type\": \"email\",\n  \"status\": \"active\",\n  \"threads\": [\n    {\n      \"type\": \"customer\",\n      \"customer\": {\n        \"email\": \"{{email}}\"\n      },\n      \"text\": \"{{message}}\"\n    }\n  ]\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.