Help Scout (API Keys) icon

CONNECT APP

Build with Help Scout (API Keys)

Simple Customer Service Software and Education

Help Desk & Support

  • API key

MCP

Give your agent Help Scout (API Keys) tools

Every Help Scout (API Keys) action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Help Scout (API Keys) account for each tool call — you store no tokens.

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{project_id}",
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "help_scout_api_keys",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Get Article:
const result = await mcp.callTool({
  name: "help_scout_api_keys-get-article",
  arguments: {
    collectionId: "Collection ID",
    categoryId: "Category ID",
  },
})

API PROXY

Call the Help Scout (API Keys) API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Help Scout (API Keys) API with the connected user's credentials attached. You store no tokens and write no refresh logic.

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://docsapi.helpscout.net/v1/collections",
})

// Any allowed Help Scout (API Keys) endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run Help Scout (API Keys) actions from your backend

Connect a user's Help Scout (API Keys) account once, then run Get Article on their behalf from your own code — TypeScript, Python, or plain HTTP.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "help_scout_api_keys-get-article",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    help_scout_api_keys: { authProvisionId: "apn_xxxxxxx" },
    collectionId: "Collection ID",
    categoryId: "Category ID",
  },
})

EVENTS

Help Scout (API Keys) triggers

Event sources your backend can deploy for users and receive through a webhook.

No Help Scout (API Keys) triggers are available yet.

REFERENCE

App details

Reference metadata for the Help Scout (API Keys) connector in the Pipedream registry.

App slug
help_scout_api_keys
Authentication
API key
Categories
Help Desk & Support
Actions
5
Triggers
0
API proxy
Available