Create Topic with ClickHelp API on New Webhook Event (Instant) from Supabase API

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

Trigger workflow on

New Webhook Event (Instant) from the Supabase 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 Supabase 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 Webhook Event (Instant) trigger
1. Connect your Supabase account
2. Configure Table
3. Optional- Configure Row Identifier
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 Webhook Event (Instant) on Supabase

Description:Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)

Version:0.0.5

Key:supabase-new-webhook-event

View on GitHub

Supabase Overview#

Supabase is a real-time backend-as-a-service that provides developers with a suite of tools to quickly build and scale their applications. It offers database storage, authentication, instant APIs, and real-time subscriptions. With the Supabase API, you can perform CRUD operations on your database, manage users, and listen to database changes in real time. When integrated with Pipedream, you can automate workflows that react to these database events, synchronize data across multiple services, or streamline user management processes.

Trigger Code#

import base from "../common/base.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "supabase-new-webhook-event",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)",
  version: "0.0.5",
  type: "source",
  props: {
    ...base.props,
    http: {
      type: "$.interface.http",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.supabase._client();
      const query = client
        .from(this.table)
        .select()
        .range(0, constants.HISTORICAL_EVENT_LIMIT);
      const { data } = await query;
      for (const row of data) {
        this.$emit({
          record: row,
        }, {
          summary: "Historical row in table",
        });
      }
    },
  },
  async run(event) {
    const { body: data } = event;
    let summary = `New ${data.type} event in table`;
    if (data.record?.[this.rowIdentifier]) {
      summary = `${summary}: ${data.record[this.rowIdentifier]}`;
    }
    this.$emit(data, {
      summary,
    });
  },
};

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
Supabase	`supabase`	`app`	This component uses the Supabase app.
Table	`table`	`string`	The name of the table to watch for new rows
Row Identifier	`rowIdentifier`	`string`	The column name to use as the row identifier
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Supabase uses API keys for authentication. When you connect your Supabase account, Pipedream securely stores the keys so you can easily authenticate to Supabase APIs in both code and no-code steps.

Supabase provides a Service Key to get started. You can find the service_role in the API Settings page.

Finding the Supabase subdomain

About Supabase#

Supabase is an open source Firebase alternative.

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 + Supabase#

Other Popular Integrations#

Create Project Backup with ClickHelp API on New Row Added from Supabase API

Supabase + ClickHelp

Try it

Create Project Backup with ClickHelp API on New Webhook Event (Instant) from Supabase API

Supabase + ClickHelp

Try it

Create Publication with ClickHelp API on New Row Added from Supabase API

Supabase + ClickHelp

Try it

Create Publication with ClickHelp API on New Webhook Event (Instant) from Supabase API

Supabase + ClickHelp

Try it

Create Topic with ClickHelp API on New Row Added from Supabase API

Supabase + ClickHelp

Try it

Popular Triggers#

New Row Added from the Supabase API

Emit new event for every new row added in a table. See documentation here

Try it

New Webhook Event (Instant) from the Supabase API

Emit new event for every insert, update, or delete operation in a table. This source requires user configuration using the Supabase website. More information in the README. Also see documentation 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