Integrate the ClickHelp API with the Formatting API

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

Start for free — no credit card required

Watch a demo

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

Popular Ways to Connect ClickHelp with Formatting#

[Data] Convert JSON to String with Formatting API on New Topic Created from ClickHelp API

ClickHelp + Formatting

Try it

[Data] Convert JSON to String with Formatting API on Topic Updated from ClickHelp API

ClickHelp + Formatting

Try it

[Data] Parse JSON with Formatting API on New Topic Created from ClickHelp API

ClickHelp + Formatting

Try it

[Data] Parse JSON with Formatting API on Topic Updated from ClickHelp API

ClickHelp + Formatting

Try it

[Date/Time] Add/Subtract Time with Formatting API on New Topic Created from ClickHelp API

ClickHelp + Formatting

Try it

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

[Data] Convert JSON to String with the Formatting API

Convert an object to a JSON format string

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

[Data] Parse JSON with the Formatting API

Parse a JSON string

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}`,
      },
    })
  },
})

Connect Formatting#

export default defineComponent({
  async run({ steps, $ }) {
    const text = ' Hello world! ';
    return text.trim()
  },
})

Start for free — no credit card required

Watch a demo