Create Topic with ClickHelp API on New Shared Drive from Google Drive API

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

Trigger workflow on

New Shared Drive from the Google Drive API

Next, do this

Create Topic 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 Google Drive 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 Shared Drive trigger
1. Connect your Google Drive account
2. Configure Polling interval
Configure the Create Topic action
1. Connect your ClickHelp account
2. Select a Project ID
3. Select a Assignee Username
4. Configure ID
5. Select a Owner Username
6. Select a Status Name
7. Optional- Configure Body
8. Optional- Configure Show in TOC?
9. Optional- Select a Parent Node ID
10. Optional- Configure Title
11. Optional- Configure TOC Node Caption
12. Optional- Configure TOC Node Ordinal Number
13. Optional- Configure Index Keywords
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 Shared Drive on Google Drive

Description:Emits a new event any time a shared drive is created.

Version:0.1.9

Key:google_drive-new-shared-drive

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Trigger Code#

import googleDrive from "../../google_drive.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "google_drive-new-shared-drive",
  name: "New Shared Drive",
  description: "Emits a new event any time a shared drive is created.",
  version: "0.1.9",
  type: "source",
  dedupe: "unique",
  props: {
    googleDrive,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Interval to poll the Google Drive API for new shared drives",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const { drives: initDrives } = await this.googleDrive.listDrivesInPage();
      for (const drive of initDrives) {
        const newDrive = await this.googleDrive.getDrive(drive.id);
        const meta = this.generateMeta(newDrive);
        this.$emit(newDrive, meta);
      }

      this._setKnownDrives(initDrives.map((drive) => drive.id));
    },
  },
  methods: {
    _getKnownDrives() {
      return this.db.get("driveIds");
    },
    _setKnownDrives(driveIds) {
      this.db.set("driveIds", Array.from(driveIds));
    },
    generateMeta(drive) {
      const ts = new Date(drive.createdTime).getTime();
      return {
        id: drive.id,
        summary: drive.name,
        ts,
      };
    },
  },
  async run() {
    const knownDrives = new Set(this._getKnownDrives());
    const drivesStream = this.googleDrive.listDrives();
    for await (const drive of drivesStream) {
      if (knownDrives.has(drive.id)) {
        // We've already seen this drive, so we skip it
        continue;
      }

      knownDrives.add(drive.id);

      const newDrive = await this.googleDrive.getDrive(drive.id);
      const meta = this.generateMeta(newDrive);
      this.$emit(newDrive, meta);
    }

    this._setKnownDrives(knownDrives);
  },
};

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
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Interval to poll the Google Drive API for new shared drives

Trigger Authentication#

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

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

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

Action#

Create Topic on ClickHelp

Description:Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-create-topic.html)

Version:0.0.1

Key:clickhelp-create-topic

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

export default {
  key: "clickhelp-create-topic",
  name: "Create Topic",
  description: "Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-create-topic.html)",
  version: "0.0.1",
  type: "action",
  props: {
    clickhelp,
    projectId: {
      propDefinition: [
        clickhelp,
        "projectId",
      ],
    },
    assigneeUserName: {
      propDefinition: [
        clickhelp,
        "userName",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      label: "Assignee Username",
      description: "Topic assignee's login",
    },
    id: {
      type: "string",
      label: "ID",
      description: "The ID of the topic",
    },
    ownerUserName: {
      propDefinition: [
        clickhelp,
        "userName",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      label: "Owner Username",
      description: "Topic owner's login",
    },
    statusName: {
      type: "string",
      label: "Status Name",
      description: "Topic's workflow status",
      options: [
        "Draft",
        "Ready",
      ],
    },
    body: {
      type: "string",
      label: "Body",
      description: "The HTML content of the topic",
      optional: true,
    },
    isShowInToc: {
      type: "boolean",
      label: "Show in TOC?",
      description: "Whether the topic's TOC node is shown in the table of contents in publications. Sets the corresponding option in the topic's properties. `false` by default",
      optional: true,
    },
    parentTocNodeId: {
      propDefinition: [
        clickhelp,
        "nodeIds",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      type: "string",
      label: "Parent Node ID",
      description: "The unique identifier of the parent TOC node. Specifying `null` will put the topic on the root level.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The topic title",
      optional: true,
    },
    tocNodeCaption: {
      type: "string",
      label: "TOC Node Caption",
      description: "Custom TOC node caption. If not specified, the topic title is used instead",
      optional: true,
    },
    tocNodeOrdinalNo: {
      type: "integer",
      label: "TOC Node Ordinal Number",
      description: "The number indicating the position of the topic's TOC node in the table of contents. If not specified, will create the topic on the last position on the respective level.",
      optional: true,
    },
    indexKeywords: {
      type: "string[]",
      label: "Index Keywords",
      description: "An array of strings containing Index Keywords to set when creating a topic",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.clickhelp.createTopic({
      $,
      projectId: this.projectId,
      data: {
        assigneeUserName: this.assigneeUserName,
        id: this.id,
        ownerUserName: this.ownerUserName,
        statusName: this.statusName,
        body: this.body,
        isShownInToc: this.isShownInToc,
        parentToNodeId: this.parentToNodeId,
        title: this.title,
        tocNodeCaption: this.tocNodeCaption,
        tocNodeOrdinalNo: this.tocNodeOrdinalNo,
        indexKeywords: this.indexKeywords,
      },
    });
    $.export("$summary", `Successfully created topic with taskKey ${response.id}`);
    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.
Assignee Username	`assigneeUserName`	`string`	Select a value from the drop down menu.
ID	`id`	`string`	The ID of the topic
Owner Username	`ownerUserName`	`string`	Select a value from the drop down menu.
Status Name	`statusName`	`string`	Select a value from the drop down menu:`DraftReady`
Body	`body`	`string`	The HTML content of the topic
Show in TOC?	`isShowInToc`	`boolean`	Whether the topic's TOC node is shown in the table of contents in publications. Sets the corresponding option in the topic's properties. `false` by default
Parent Node ID	`parentTocNodeId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The topic title
TOC Node Caption	`tocNodeCaption`	`string`	Custom TOC node caption. If not specified, the topic title is used instead
TOC Node Ordinal Number	`tocNodeOrdinalNo`	`integer`	The number indicating the position of the topic's TOC node in the table of contents. If not specified, will create the topic on the last position on the respective level.
Index Keywords	`indexKeywords`	`string[]`	An array of strings containing Index Keywords to set when creating a topic

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 + Google Drive#

Other Popular Integrations#

Create Project Backup with ClickHelp API on New Shared Drive from Google Drive API

Google Drive + ClickHelp

Create Topic with ClickHelp API on New Shared Drive from Google Drive API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular