← ClickHelp

Create Topic with ClickHelp API

Pipedream makes it easy to connect APIs for ClickHelp and 2,100+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Topic with the ClickHelp API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Topic with the ClickHelp API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Topic action
    1. Connect your ClickHelp account
    2. Select a Project ID
    3. Select a Assignee Username
    4. Configure ID
    5. Select a Owner Username
    6. Select a Status Name
    7. Optional- Configure Body
    8. Optional- Configure Show in TOC?
    9. Optional- Select a Parent Node ID
    10. Optional- Configure Title
    11. Optional- Configure TOC Node Caption
    12. Optional- Configure TOC Node Ordinal Number
    13. Optional- Configure Index Keywords
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Topic with ClickHelp API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + ClickHelp
 
Try it
Create Topic with ClickHelp API on New Submission from Typeform API
Typeform + ClickHelp
 
Try it
Create Topic with ClickHelp API on New Submission (Instant) from Jotform API
Jotform + ClickHelp
 
Try it
Create Topic with ClickHelp API on New Scheduled Tasks from Pipedream API
Pipedream + ClickHelp
 
Try it
Create Topic with ClickHelp API on npm Download Counts from npm API
npm + ClickHelp
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Topic on ClickHelp
Description:Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-create-topic.html)
Version:0.0.1
Key:clickhelp-create-topic

Code

import clickhelp from "../../clickhelp.app.mjs";

export default {
  key: "clickhelp-create-topic",
  name: "Create Topic",
  description: "Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-create-topic.html)",
  version: "0.0.1",
  type: "action",
  props: {
    clickhelp,
    projectId: {
      propDefinition: [
        clickhelp,
        "projectId",
      ],
    },
    assigneeUserName: {
      propDefinition: [
        clickhelp,
        "userName",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      label: "Assignee Username",
      description: "Topic assignee's login",
    },
    id: {
      type: "string",
      label: "ID",
      description: "The ID of the topic",
    },
    ownerUserName: {
      propDefinition: [
        clickhelp,
        "userName",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      label: "Owner Username",
      description: "Topic owner's login",
    },
    statusName: {
      type: "string",
      label: "Status Name",
      description: "Topic's workflow status",
      options: [
        "Draft",
        "Ready",
      ],
    },
    body: {
      type: "string",
      label: "Body",
      description: "The HTML content of the topic",
      optional: true,
    },
    isShowInToc: {
      type: "boolean",
      label: "Show in TOC?",
      description: "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: true,
    },
    parentTocNodeId: {
      propDefinition: [
        clickhelp,
        "nodeIds",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      type: "string",
      label: "Parent Node ID",
      description: "The unique identifier of the parent TOC node. Specifying `null` will put the topic on the root level.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The topic title",
      optional: true,
    },
    tocNodeCaption: {
      type: "string",
      label: "TOC Node Caption",
      description: "Custom TOC node caption. If not specified, the topic title is used instead",
      optional: true,
    },
    tocNodeOrdinalNo: {
      type: "integer",
      label: "TOC Node Ordinal Number",
      description: "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: true,
    },
    indexKeywords: {
      type: "string[]",
      label: "Index Keywords",
      description: "An array of strings containing Index Keywords to set when creating a topic",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.clickhelp.createTopic({
      $,
      projectId: this.projectId,
      data: {
        assigneeUserName: this.assigneeUserName,
        id: this.id,
        ownerUserName: this.ownerUserName,
        statusName: this.statusName,
        body: this.body,
        isShownInToc: this.isShownInToc,
        parentToNodeId: this.parentToNodeId,
        title: this.title,
        tocNodeCaption: this.tocNodeCaption,
        tocNodeOrdinalNo: this.tocNodeOrdinalNo,
        indexKeywords: this.indexKeywords,
      },
    });
    $.export("$summary", `Successfully created topic with taskKey ${response.id}`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
ClickHelpclickhelpappThis component uses the ClickHelp app.
Project IDprojectIdstringSelect a value from the drop down menu.
Assignee UsernameassigneeUserNamestringSelect a value from the drop down menu.
IDidstring

The ID of the topic

Owner UsernameownerUserNamestringSelect a value from the drop down menu.
Status NamestatusNamestringSelect a value from the drop down menu:DraftReady
Bodybodystring

The HTML content of the topic

Show in TOC?isShowInTocboolean

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

Parent Node IDparentTocNodeIdstringSelect a value from the drop down menu.
Titletitlestring

The topic title

TOC Node CaptiontocNodeCaptionstring

Custom TOC node caption. If not specified, the topic title is used instead

TOC Node Ordinal NumbertocNodeOrdinalNointeger

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.

Index KeywordsindexKeywordsstring[]

An array of strings containing Index Keywords to set when creating a topic

Authentication

ClickHelp uses API keys for authentication. When you connect your ClickHelp account, Pipedream securely stores the keys so you can easily authenticate to ClickHelp APIs in both code and no-code steps.

About ClickHelp

AI-powered all-in-one documentation tool.

More Ways to Use ClickHelp

Triggers

New Topic Created from the ClickHelp API

Emit new event when a topic is created. See the documentation

 
Try it
Topic Updated from the ClickHelp API

Emit new event when a topic is updated. See the documentation

 
Try it

Actions

Create Project Backup with the ClickHelp API

Generates a backup of the specified project. This action ensures you have a safe copy of your project in case of any unpredicted data loss. See the documentation

 
Try it
Create Publication with the ClickHelp API

Creates a new publication from the designated project. This action allows you to share your content with others in various formats. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,100+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.