Get Help Scout Conversation Status

Looks up one Help Scout conversation by its number and returns its status.

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. Find a conversation using the conversation number the customer gives you, such as from a confirmation email. The response lists matching conversations in _embedded.conversations, each with a status of active, pending, closed or spam, and a subject. Only share the status and subject with the customer. If the list is empty, tell the customer you could not find it.

Request

GEThttps://api.helpscout.net/v2/conversations?number={{number}}&status=all

Headers

AuthorizationBearer {{accessToken}}

Parameters

number numberThe conversation number.
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": "60344317-b38d-492f-8b42-f16c305e2e8c",
    "type": "HTTP_REQUEST",
    "label": "Get Help Scout Conversation Status",
    "name": "get_help_scout_conversation_status",
    "customName": false,
    "description": "Get a Help Scout access token first if you do not already have one. Find a conversation using the conversation number the customer gives you, such as from a confirmation email. The response lists matching conversations in _embedded.conversations, each with a status of active, pending, closed or spam, and a subject. Only share the status and subject with the customer. If the list is empty, tell the customer you could not find it.",
    "parameters": [
      {
        "name": "number",
        "type": "number",
        "description": "The conversation number."
      },
      {
        "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": "GET",
        "url": "https://api.helpscout.net/v2/conversations?number={{number}}&status=all"
      },
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": null,
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.