Create Project Backup with ClickHelp API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Project Backup with the ClickHelp API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Create Project Backup action
1. Connect your ClickHelp account
2. Select a Project ID
3. Configure Output File Name
4. Optional- Configure Wait for Completion
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Project Backup with ClickHelp API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ClickHelp

Try it

Create Project Backup with ClickHelp API on New Submission from Typeform API

Typeform + ClickHelp

Try it

Create Project Backup with ClickHelp API on New Submission (Instant) from Jotform API

Jotform + ClickHelp

Try it

Create Project Backup with ClickHelp API on New Scheduled Tasks from Pipedream API

Pipedream + ClickHelp

Try it

Create Project Backup 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 Project Backup on ClickHelp

Description: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](https://clickhelp.com/software-documentation-tool/user-manual/api-create-project-backup.html)

Version:0.0.1

Key:clickhelp-create-project-backup

View on GitHub

Code#

import clickhelp from "../../clickhelp.app.mjs";
import { pollTaskStatus } from "../../common/utils.mjs";

export default {
  key: "clickhelp-create-project-backup",
  name: "Create Project Backup",
  description: "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](https://clickhelp.com/software-documentation-tool/user-manual/api-create-project-backup.html)",
  version: "0.0.1",
  type: "action",
  props: {
    clickhelp,
    projectId: {
      propDefinition: [
        clickhelp,
        "projectId",
      ],
    },
    outputFileName: {
      type: "string",
      label: "Output File Name",
      description: "The full file name of the output file, including the file path that starts with `Storage/`. Example: `Storage/Backups/Project-backup_2023-03-13_03-46-07.zip`",
    },
    waitForCompletion: {
      propDefinition: [
        clickhelp,
        "waitForCompletion",
      ],
    },
  },
  async run({ $ }) {
    let response = await this.clickhelp.createProjectBackup({
      $,
      projectId: this.projectId,
      params: {
        action: "download",
      },
      data: {
        outputFileName: this.outputFileName,
      },
    });

    const { taskKey } = response;
    if (this.waitForCompletion) {
      response = await pollTaskStatus($, this, taskKey);
    }

    $.export("$summary", "Successfully created project backup.");
    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.

Label	Prop	Type	Description
ClickHelp	`clickhelp`	`app`	This component uses the ClickHelp app.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Output File Name	`outputFileName`	`string`	The full file name of the output file, including the file path that starts with `Storage/`. Example: `Storage/Backups/Project-backup_2023-03-13_03-46-07.zip`
Wait for Completion	`waitForCompletion`	`boolean`	Set to `true` to poll the API in 3-second intervals until the task is completed

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 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