Integrate the ClickHelp API with the Node API

Setup the ClickHelp API trigger to run a workflow which integrates with the Node API. Pipedream's integration platform allows you to integrate ClickHelp and Node remarkably fast. Free for developers.

Popular Ways to Connect ClickHelp with Node#

Run Node Code with Node API on New Topic Created from ClickHelp API

ClickHelp + Node

Try it

Run Node Code with Node API on Topic Updated from ClickHelp API

ClickHelp + Node

Try it

Popular ClickHelp and Node 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

Popular ClickHelp and Node 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

Run Node Code with the Node API

Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the Pipedream Node docs to learn more.

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

Create Topic with the ClickHelp API

Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. See the documentation

Try it

Overview of ClickHelp#

The ClickHelp API allows technical writers to automate and interact with the ClickHelp documentation platform programmatically. With this API, Pipedream users can create, update, retrieve, and manage documentation projects, topics, and users within ClickHelp. It opens up opportunities to streamline documentation workflows, integrate with content management systems, and trigger notifications based on documentation changes or reviews.

Connect ClickHelp#

import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    clickhelp: {
      type: "app",
      app: "clickhelp",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://${this.clickhelp.$auth.portal_domain}/api/v1/users`,
      auth: {
        username: `${this.clickhelp.$auth.email}`,
        password: `${this.clickhelp.$auth.api_key}`,
      },
    })
  },
})

Overview of Node#

Develop, run and deploy your Node.js code in Pipedream workflows, using it between no-code steps, with connected accounts, or integrate Data Stores and File Stores.

This includes installing NPM packages, within your code without having to manage a package.json file or running npm install.

Below is an example of installing the axios package in a Pipedream Node.js code step. Pipedream imports the axios package, performs the API request, and shares the response with subsequent workflow steps:

Connect Node#

// To use previous step data, pass the `steps` object to the run() function
export default defineComponent({
  async run({ steps, $ }) {
    // Return data to use it in future steps
    return steps.trigger.event
  },
})