ClickHelp API Integrations
Build and run workflows using the ClickHelp API. Use 1000s of source-available triggers and actions across 2,000+ apps. Or write custom code to integrate any app or API in seconds.
Overview#
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.
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}`,
},
})
},
})
Choose an API to Connect with ClickHelp API#
1-24of2,000+apps by most popular
Example Use Cases#
Automated Documentation Backup
Build a workflow in Pipedream to automatically back up ClickHelp projects to a cloud storage service like Google Drive or Dropbox at regular intervals. This ensures that you always have an up-to-date copy of your documentation, providing an extra layer of data protection.Documentation Review and Approval Process
Create a Pipedream workflow that triggers when a new topic is added or updated in ClickHelp. It can notify stakeholders through Slack or email to review the content. Once reviewed, the workflow can update the topic status in ClickHelp based on the feedback received, streamlining the review process.Syncing Help Content with a CRM
Develop a workflow on Pipedream that synchronizes ClickHelp documentation with a CRM like Salesforce. When new documentation is published or existing documents are updated in ClickHelp, the workflow can update the corresponding records or files in Salesforce, ensuring the sales team has access to the latest help content.
Popular ClickHelp Integrations#
Popular ClickHelp Triggers#
Emit new event when a topic is created. See the documentation
Popular ClickHelp Actions#
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
Creates a new publication from the designated project. This action allows you to share your content with others in various formats. See the documentation
Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. See the documentation
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.