CONNECT APP
Build with HelpDocs
The Documentation Engine Behind AI-Driven Support
Help Desk & Support
- API key
MCP
Give your agent HelpDocs tools
Every HelpDocs 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 HelpDocs 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": "helpdocs",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Article:
const result = await mcp.callTool({
name: "helpdocs-create-article",
arguments: {
title: "Title",
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": "helpdocs",
}
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 Create Article:
result = await session.call_tool("helpdocs-create-article", {
"title": "Title",
"categoryId": "Category ID",
})SDK
Run HelpDocs actions from your backend
Connect a user's HelpDocs account once, then run Create 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: "helpdocs-create-article",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
helpdocs: { authProvisionId: "apn_xxxxxxx" },
title: "Title",
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="helpdocs-create-article",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"helpdocs": {"authProvisionId": "apn_xxxxxxx"},
"title": "Title",
"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": "helpdocs-create-article",
"configured_props": {
"helpdocs": { "authProvisionId": "apn_xxxxxxx" },
"title": "Title",
"categoryId": "Category ID"
}
}'TOOLS
HelpDocs actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Article
actionCreate a new article in your HelpDocs knowledge base. See the documentationWritev0.0.2 -
Create Category
actionCreate a new category in your HelpDocs knowledge base to organize articles. See the documentationWritev0.0.2 -
Delete Article
actionDelete an article from your HelpDocs knowledge base. See the documentationWritev0.0.2 -
Delete Category
actionDelete a category from your HelpDocs knowledge base. See the documentationWritev0.0.2 -
Generate Chatbot Source Page
actionThe chatbot source page feature allows you to generate a comprehensive list of all your Knowledge Base articles that can be fed directly to your chatbot. This makes it easy to leverage your existing documentation to power AI assistants and help your customers find answers quickly. See the documentationRead-onlyv0.0.2 -
Get Article
actionRetrieve a specific article from your HelpDocs knowledge base. See the documentationRead-onlyv0.0.2 -
Get Article Versions
actionRetrieve version history and details for a specific article in your knowledge base. See the documentationRead-onlyv0.0.2 -
Get Category
actionRetrieve a category from your HelpDocs knowledge base. See the documentationRead-onlyv0.0.2 -
List Article ID Options
actionRetrieves available options for the Article ID field.Read-onlyv0.0.1 -
List Articles
actionRetrieve a list of articles from your HelpDocs knowledge base. See the documentationRead-onlyv0.0.3 -
List Categories
actionRetrieve a list of all categories in your HelpDocs knowledge base. See the documentationRead-onlyv0.0.2 -
List Group ID Options
actionRetrieves available options for the Group ID field.Read-onlyv0.0.1 -
Search Articles
actionSearch for articles in your HelpDocs knowledge base. See the documentationRead-onlyv0.0.2
EVENTS
HelpDocs triggers
Event sources your backend can deploy for users and receive through a webhook.
No HelpDocs triggers are available yet.
- App slug
- helpdocs
- Authentication
- API key
- Categories
- Help Desk & Support
- Actions
- 13
- Triggers
- 0
- API proxy
- Not available