View as Markdown
ClickHelp icon

ClickHelp ACTION

Create Publication

Creates a new publication from the designated project. This action allows you to share your content with others in various formats. 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 Publication 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-publication",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clickhelp: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Project ID",
    pubId: "Pub ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Publication inputs
Property Type Description
projectId Project ID string
Identifier of a project
Required Dynamic
pubId Pub ID string
The ID of the publication to create
Required
pubName Pub Name string
The name of the publication to create
Required
isPublishOnlyReadyTopics Publish Only Ready Topics? boolean
Whether to publish only topics in the Ready status
Optional
pubVisibility Pub Visibility string
The target publication visibility. Defalts to Public.
Optional
nodeIds Node IDs string[]
An array of strings containing IDs of the TOC nodes to publish. If not specified, the entire project is published.
Optional Dynamic
waitForCompletion Wait for Completion boolean
Set to true to poll the API in 3-second intervals until the task is completed
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-publication
Version
0.0.2
App
ClickHelp
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes