Create Publication with ClickHelp API on New Package Version from npm API

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

Trigger workflow on

New Package Version from the npm API

Next, do this

Create Publication 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 npm 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 Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Create Publication action
1. Connect your ClickHelp account
2. Select a Project ID
3. Configure Pub ID
4. Configure Pub Name
5. Optional- Configure Publish Only Ready Topics?
6. Optional- Select a Pub Visibility
7. Optional- Select one or more Node IDs
8. 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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

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

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Publication on ClickHelp

Description:Creates a new publication from the designated project. This action allows you to share your content with others in various formats. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-publish-project.html)

Version:0.0.1

Key:clickhelp-create-publication

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-publication",
  name: "Create Publication",
  description: "Creates a new publication from the designated project. This action allows you to share your content with others in various formats. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-publish-project.html)",
  version: "0.0.1",
  type: "action",
  props: {
    clickhelp,
    projectId: {
      propDefinition: [
        clickhelp,
        "projectId",
      ],
    },
    pubId: {
      type: "string",
      label: "Pub ID",
      description: "The ID of the publication to create",
    },
    pubName: {
      type: "string",
      label: "Pub Name",
      description: "The name of the publication to create",
    },
    isPublishOnlyReadyTopics: {
      type: "boolean",
      label: "Publish Only Ready Topics?",
      description: "Whether to publish only topics in the Ready status",
      optional: true,
    },
    pubVisibility: {
      type: "string",
      label: "Pub Visibility",
      description: "The target publication visibility. Defalts to `Public`.",
      optional: true,
      options: [
        "Public",
        "Private",
        "Restricted",
      ],
      default: "Public",
    },
    nodeIds: {
      propDefinition: [
        clickhelp,
        "nodeIds",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    waitForCompletion: {
      propDefinition: [
        clickhelp,
        "waitForCompletion",
      ],
    },
  },
  async run({ $ }) {
    let response = await this.clickhelp.createPublication({
      $,
      projectId: this.projectId,
      data: {
        pubId: this.pubId,
        pubName: this.pubName,
        isPublishOnlyReadyTopics: this.isPublishOnlyReadyTopics,
        pubVisibility: this.pubVisibility,
        publishedTocNodeIds: this.nodeIds,
      },
    });

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

    $.export("$summary", "Successfully created publication.");
    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.
Pub ID	`pubId`	`string`	The ID of the publication to create
Pub Name	`pubName`	`string`	The name of the publication to create
Publish Only Ready Topics?	`isPublishOnlyReadyTopics`	`boolean`	Whether to publish only topics in the Ready status
Pub Visibility	`pubVisibility`	`string`	Select a value from the drop down menu:`PublicPrivateRestricted`
Node IDs	`nodeIds`	`string[]`	Select a value from the drop down menu.
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 + npm#

Other Popular Integrations#

Create Project Backup with ClickHelp API on npm Download Counts from npm API

npm + ClickHelp

Try it

Create Publication with ClickHelp API on npm Download Counts from npm API

npm + ClickHelp

Try it

Create Topic with ClickHelp API on npm Download Counts from npm API

npm + ClickHelp

Try it

Create Project Backup with ClickHelp API on New Package Version from npm API

npm + ClickHelp

Try it

Create Topic with ClickHelp API on New Package Version from npm API

npm + ClickHelp

Try it

Popular Triggers#

New Download Counts from the npm API

Emit new event with the latest count of downloads for an npm package. See the documentation.

Try it

New Package Version from the npm API

Emit new event when a new version of an npm package is published. See the documentation

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