CONNECT APP
Build with Help Scout
Help Desk & Support
- OAuth
MCP
Give your agent Help Scout tools
Every Help Scout 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 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",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Note to Conversation:
const result = await mcp.callTool({
name: "help_scout-add-note",
arguments: {
conversationId: "Conversation ID",
text: "Text",
},
})# 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",
}
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 Add Note to Conversation:
result = await session.call_tool("help_scout-add-note", {
"conversationId": "Conversation ID",
"text": "Text",
})API PROXY
Call the Help Scout API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Help Scout 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://api.helpscout.net/v2/users/me",
})
// Any allowed Help Scout 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://api.helpscout.net/v2/users/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuaGVscHNjb3V0Lm5ldC92Mi91c2Vycy9tZQ?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Help Scout actions from your backend
Connect a user's Help Scout account once, then run Add Note to Conversation 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-add-note",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
help_scout: { authProvisionId: "apn_xxxxxxx" },
conversationId: "Conversation ID",
text: "Text",
},
})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-add-note",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"help_scout": {"authProvisionId": "apn_xxxxxxx"},
"conversationId": "Conversation ID",
"text": "Text",
},
)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-add-note",
"configured_props": {
"help_scout": { "authProvisionId": "apn_xxxxxxx" },
"conversationId": "Conversation ID",
"text": "Text"
}
}'TOOLS
Help Scout actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Note to Conversation
actionAdds a note to an existing conversation in Help Scout. See the documentationWritev0.0.5 -
Create Customer
actionCreates a new customer record in Help Scout. See the documentationWritev0.0.5 -
Get Conversation Details
actionRetrieves the details of a specific conversation. See the documentationRead-onlyv0.0.4 -
Get Conversation Threads
actionRetrieves the threads of a specific conversation. See the documentationRead-onlyv0.0.4 -
Get Tag by ID
actionGets a tag by its ID. See the documentationRead-onlyv0.0.2 -
List Conversation ID Options
actionRetrieves available options for the Conversation ID field.Read-onlyv0.0.1 -
List Customer ID Options
actionRetrieves available options for the Customer ID field.Read-onlyv0.0.1 -
List Tag ID Options
actionRetrieves available options for the Tag ID field.Read-onlyv0.0.1 -
List Tags
actionLists all tags in Help Scout. See the documentationRead-onlyv0.0.2 -
List User ID Options
actionRetrieves available options for the User ID field.Read-onlyv0.0.1 -
Send Reply
actionSends a reply to a conversation. Be careful as this sends an actual email to the customer. See the documentationWritev0.0.6 -
Update Conversation
actionUpdates a conversation. See the documentationWritev0.0.2
EVENTS
Help Scout triggers
Event sources your backend can deploy for users and receive through a webhook.
-
Conversation Status Updated (Instant)
triggerEmit new event when a conversation has its status updated. See the documentationInstantv0.0.3 -
New Agent Reply (Instant)
triggerEmit new event when an agent replies to a conversation.Instantv0.0.4 -
New Conversation Assigned (Instant)
triggerEmit new event when a conversation is assigned to an agent. See the documentationInstantv0.0.5 -
New Conversation Created (Instant)
triggerEmit new event when a new conversation is created.Instantv0.0.5 -
New Customer Added (Instant)
triggerEmit new event when a new customer is added.Instantv0.0.5 -
New Customer Reply (Instant)
triggerEmit new event when a customer replies to a conversation.Instantv0.0.4 -
New Note Created (Instant)
triggerEmit new event when a note is added to a conversation.Instantv0.0.4
MULTI-APP
Use Help Scout with other popular apps
Most products don't stop at one integration. Pair Help Scout with the other apps your users rely on, and ship use cases that span both.
- App slug
- help_scout
- Authentication
- OAuth
- Categories
- Help Desk & Support
- Actions
- 12
- Triggers
- 7
- API proxy
- Available