View as Markdown
HelpDocs icon

HelpDocs ACTION

Create Article

Create a new article in your HelpDocs knowledge base. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HelpDocs account once, then configure and run Create Article 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: "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",
  },
})

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 Article inputs
Property Type Description
title Title string
The title of the article
Required
categoryId Category ID string
The ID of a category
Optional Dynamic
body Body string
The body of the article
Optional
isPrivate Is Private boolean
Whether the article is private
Optional
isPublished Is Published boolean
Whether the article is published
Optional
description Description string
The description of the article
Optional
shortVersion Short Version string
The short version of the article
Optional
slug Slug string
The slug of the article
Optional
tags Tags string[]
The tags of the article
Optional
multilingual Multilingual string[]
The language code(s) of the article (e.g. en, fr, etc.)
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
helpdocs-create-article
Version
0.0.2
App
HelpDocs
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes