Create Project Backup with ClickHelp API on New Board Event from Pinterest API

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

Trigger workflow on

New Board Event from the Pinterest API

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#

This integration creates a workflow with a Pinterest trigger and ClickHelp action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Board Event trigger
1. Connect your Pinterest account
2. Configure timer
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Board Event on Pinterest

Description:Emit new events when new boards are created. [See the docs](https://developers.pinterest.com/docs/api/v5/#operation/boards/list)

Version:0.1.0

Key:pinterest-new-board

View on GitHub

Pinterest Overview#

The Pinterest API opens a portal to interact programmatically with Pinterest's rich data, including boards, pins, and user information. By leveraging this API on Pipedream, you can automate actions like posting new pins, extracting pin data for analysis, and synchronizing Pinterest content with other platforms. The potential extends to marketing optimization, content management, and audience engagement, all automated and integrated within the Pipedream ecosystem.

Trigger Code#

import pinterest from "../../pinterest.app.mjs";
import common from "../common.mjs";

export default {
  key: "pinterest-new-board",
  name: "New Board Event",
  description: "Emit new events when new boards are created. [See the docs](https://developers.pinterest.com/docs/api/v5/#operation/boards/list)",
  version: "0.1.0",
  type: "source",
  ...common,
  props: {
    pinterest,
    ...common.props,
  },
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.pinterest.getBoards;
    },
    getResourceFnArgs() {
      return {};
    },
    getSummary(item) {
      return `New board ${item.name} (ID:${item.id})`;
    },
    compareFn(item) {
      return this.getLastId() < item.id;
    },
  },
};

Trigger 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
Pinterest	`pinterest`	`app`	This component uses the Pinterest app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pinterest uses OAuth authentication. When you connect your Pinterest account, Pipedream will open a popup window where you can sign into Pinterest and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Pinterest API.

Pipedream requests the following authorization scopes when you connect your account:

boards:readboards:read_secretboards:writeboards:write_secretpins:readpins:read_secretpins:writepins:write_secretuser_accounts:read

About Pinterest#

Pinterest is a visual discovery engine for finding ideas like recipes, home and style inspiration, and more.

Action#

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

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

Action 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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

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

Action 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 Connect ClickHelp + Pinterest#

Other Popular Integrations#

Create Project Backup with ClickHelp API on New Pin Event from Pinterest API

Pinterest + ClickHelp

Try it

Create Publication with ClickHelp API on New Board Event from Pinterest API

Pinterest + ClickHelp

Try it

Create Publication with ClickHelp API on New Pin Event from Pinterest API

Pinterest + ClickHelp

Try it

Create Topic with ClickHelp API on New Board Event from Pinterest API

Pinterest + ClickHelp

Try it

Create Topic with ClickHelp API on New Pin Event from Pinterest API

Pinterest + ClickHelp

Try it

Popular Triggers#

New Board Event from the Pinterest API

Emit new events when new boards are created. See the docs

Try it

New Pin Event from the Pinterest API

Emit new events when new pins are created on a board or board section. See the docs here and here

Try it

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

Create a Pin with the Pinterest API

Create a Pin on a board or board section, See the docs

Try it

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

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