Create Publication with ClickHelp API on New Page in Data Source from Notion API

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

Trigger workflow on

New Page in Data Source from the Notion 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 Notion 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 Page in Data Source trigger
1. Connect your Notion account
2. Configure timer
3. Select a Data Source ID
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 Page in Data Source on Notion

Description:Emit new event when a page is created in the selected data source. [See the documentation](https://developers.notion.com/reference/page)

Version:1.0.1

Key:notion-new-page

View on GitHub

Notion Overview#

Notion's API allows for the creation, reading, updating, and deleting of pages, databases, and their contents within Notion. Using Pipedream's platform, you can build workflows that connect Notion with various other services to automate tasks such as content management, task tracking, and data synchronization. With Pipedream's serverless execution, you can trigger these workflows on a schedule, or by external events from other services, without managing any infrastructure.

Trigger Code#

import notion from "../../notion.app.mjs";
import base from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "notion-new-page",
  name: "New Page in Data Source",
  description: "Emit new event when a page is created in the selected data source. [See the documentation](https://developers.notion.com/reference/page)",
  version: "1.0.1",
  type: "source",
  props: {
    ...base.props,
    dataSourceId: {
      propDefinition: [
        notion,
        "dataSourceId",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      await this.processEvents(25);
    },
  },
  methods: {
    ...base.methods,
    async processEvents(max) {
      const pages = [];
      const lastCreatedTimestamp = this.getLastCreatedTimestamp();
      const lastCreatedTimestampDate = new Date(lastCreatedTimestamp);
      const lastCreatedTimestampISO = lastCreatedTimestampDate.toISOString();

      // Add a filter so that we only receive pages that have been created since the saved time.
      const params = {
        ...this.lastCreatedSortParam(),
        filter: {
          timestamp: "created_time",
          created_time: {
            after: lastCreatedTimestampISO,
          },
        },
      };

      // Get pages in created order descending until the first page edited after
      // lastCreatedTimestamp, then reverse list of pages and emit
      const pagesStream = this.notion.getPages(this.dataSourceId, params);

      for await (const page of pagesStream) {
        if (!this.isResultNew(page.created_time, lastCreatedTimestamp)
          || (max && pages.length >= max)) {
          break;
        }
        pages.push(page);
      }

      pages.reverse().forEach((page) => {
        const meta = this.generateMeta(
          page,
          constants.types.PAGE,
          constants.timestamps.CREATED_TIME,
          constants.summaries.PAGE_ADDED,
        );
        this.$emit(page, meta);
      });

      const lastCreatedTime = pages[pages.length - 1]?.created_time;
      if (lastCreatedTime) {
        this.setLastCreatedTimestamp(Date.parse(lastCreatedTime));
      }
    },
  },
  async run() {
    await this.processEvents(100);
  },
  sampleEmit,
};

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
Notion	`notion`	`app`	This component uses the Notion app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Data Source ID	`dataSourceId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Notion#

Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.

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

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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

Create Publication with ClickHelp API on New Page in Data Source from Notion API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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