ClickHelp ACTION
Create Topic
Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's ClickHelp account once, then configure and run Create Topic from your backend or agent.
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: "clickhelp-create-topic",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
clickhelp: { authProvisionId: "apn_xxxxxxx" },
projectId: "Project ID",
assigneeUserName: "Assignee Username",
},
})
console.log(result)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": "clickhelp-create-topic",
"configured_props": {
"clickhelp": { "authProvisionId": "apn_xxxxxxx" },
"projectId": "Project ID",
"assigneeUserName": "Assignee Username"
}
}'// 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": "clickhelp",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "clickhelp-create-topic",
arguments: {
projectId: "Project ID",
assigneeUserName: "Assignee Username",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
projectId Project ID | string | Identifier of a project Required Dynamic |
assigneeUserName Assignee Username | string | Topic assignee's login Required Dynamic |
id ID | string | The ID of the topic Required |
ownerUserName Owner Username | string | Topic owner's login Required Dynamic |
statusName Status Name | string | Topic's workflow status Required |
body Body | string | The HTML content of the topic Optional |
isShowInToc Show in TOC? | boolean | Whether the topic's TOC node is shown in the table of contents in publications. Sets the corresponding option in the topic's properties. false by default Optional |
parentTocNodeId Parent Node ID | string | The unique identifier of the parent TOC node. Specifying null will put the topic on the root level. Optional Dynamic |
title Title | string | The topic title Optional |
tocNodeCaption TOC Node Caption | string | Custom TOC node caption. If not specified, the topic title is used instead Optional |
tocNodeOrdinalNo TOC Node Ordinal Number | integer | The number indicating the position of the topic's TOC node in the table of contents. If not specified, will create the topic on the last position on the respective level. Optional |
indexKeywords Index Keywords | string[] | An array of strings containing Index Keywords to set when creating a topic Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- clickhelp-create-topic
- Version
- 0.0.2
- App
- ClickHelp
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗