Help Scout

Get Help Scout Access Token

Gets the access token the other Help Scout tools need. The bot calls this first.

Unverified

What the model is told

Get an access token for Help Scout. Call this once before any other Help Scout tool, then pass the access_token value from the response to those tools. Never read the token aloud or share it with the customer. If a Help Scout tool returns a 401, call this again to get a fresh token.

Request

POSThttps://api.helpscout.net/v2/oauth2/token

Headers

  • Content-Typeapplication/x-www-form-urlencoded

Body

grant_type=client_credentials&client_id=YOUR_HELPSCOUT_APP_ID&client_secret=YOUR_HELPSCOUT_APP_SECRET

Parameters

None.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "c4e5f20a-f43e-4715-8b5b-9db7f43325aa",
    "type": "HTTP_REQUEST",
    "label": "Get Help Scout Access Token",
    "name": "get_help_scout_access_token",
    "customName": false,
    "description": "Get an access token for Help Scout. Call this once before any other Help Scout tool, then pass the access_token value from the response to those tools. Never read the token aloud or share it with the customer. If a Help Scout tool returns a 401, call this again to get a fresh token.",
    "parameters": [],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://api.helpscout.net/v2/oauth2/token"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/x-www-form-urlencoded"
        }
      ],
      "body": "grant_type=client_credentials&client_id=YOUR_HELPSCOUT_APP_ID&client_secret=YOUR_HELPSCOUT_APP_SECRET",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.