CONNECT APP
Build with Help Scout (API Keys)
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",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Get Article:
result = await session.call_tool("help_scout_api_keys-get-article", {
"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.# The path segment is the target URL, URL-safe base64 encoded:
# https://docsapi.helpscout.net/v1/collections
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9kb2NzYXBpLmhlbHBzY291dC5uZXQvdjEvY29sbGVjdGlvbnM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="help_scout_api_keys-get-article",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"help_scout_api_keys": {"authProvisionId": "apn_xxxxxxx"},
"collectionId": "Collection ID",
"categoryId": "Category ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "help_scout_api_keys-get-article",
"configured_props": {
"help_scout_api_keys": { "authProvisionId": "apn_xxxxxxx" },
"collectionId": "Collection ID",
"categoryId": "Category ID"
}
}'TOOLS
Help Scout (API Keys) actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Get Article
actionRetrieve a single article by ID or number. See the documentationRead-onlyv0.0.1 -
List Articles
actionRetrieve a list of articles by collection or category. See the documentationRead-onlyv0.0.1 -
List Collection ID Options
actionRetrieves available options for the Collection ID field.Read-onlyv0.0.1 -
List Site ID Options
actionRetrieves available options for the Site ID field.Read-onlyv0.0.1 -
Search Articles
actionSearch for articles by keyword. See the documentationRead-onlyv0.0.1
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