Create Topic with ClickHelp API on New Custom Webhook Events from Stripe API

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

Trigger workflow on

New Custom Webhook Events from the Stripe 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 Stripe 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 Custom Webhook Events trigger
1. Connect your Stripe account
2. Select one or more Events
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 Custom Webhook Events on Stripe

Description:Emit new event on each webhook event

Version:0.1.1

Key:stripe-custom-webhook-events

View on GitHub

Stripe Overview#

The Stripe API is a powerful tool for managing online payments, subscriptions, and invoices. With Pipedream, you can leverage this API to automate payment processing, monitor transactions, and sync billing data with other services. Pipedream's no-code platform allows for quick integration and creation of serverless workflows that react to Stripe events in real-time. For instance, you might automatically update customer records, send personalized emails after successful payments, or escalate failed transactions to your support team.

Trigger Code#

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

export default {
  ...common,
  key: "stripe-custom-webhook-events",
  name: "New Custom Webhook Events",
  type: "source",
  version: "0.1.1",
  description: "Emit new event on each webhook event",
  props: {
    ...common.props,
    enabledEvents: {
      type: "string[]",
      label: "Events",
      description: "Events to listen for. Select `*` for all events",
      options: constants.WEBHOOK_EVENTS,
      default: [
        "*",
      ],
    },
  },
  methods: {
    ...common.methods,
    getEvents() {
      return this.enabledEvents;
    },
  },
  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
Stripe	`stripe`	`app`	This component uses the Stripe app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Events	`enabledEvents`	`string[]`	Select a value from the drop down menu:`*account.application.authorizedaccount.application.deauthorizedaccount.external_account.createdaccount.external_account.deletedaccount.external_account.updatedaccount.updatedapplication_fee.createdapplication_fee.refund.updatedapplication_fee.refundedbalance.availablecapability.updatedcharge.capturedcharge.dispute.closedcharge.dispute.createdcharge.dispute.funds_reinstatedcharge.dispute.funds_withdrawncharge.dispute.updatedcharge.expiredcharge.failedcharge.pendingcharge.refund.updatedcharge.refundedcharge.succeededcharge.updatedcheckout.session.async_payment_failedcheckout.session.async_payment_succeededcheckout.session.completedcoupon.createdcoupon.deletedcoupon.updatedcredit_note.createdcredit_note.updatedcredit_note.voidedcustomer.createdcustomer.deletedcustomer.discount.createdcustomer.discount.deletedcustomer.discount.updatedcustomer.source.createdcustomer.source.deletedcustomer.source.expiringcustomer.source.updatedcustomer.subscription.createdcustomer.subscription.deletedcustomer.subscription.pending_update_appliedcustomer.subscription.pending_update_expiredcustomer.subscription.trial_will_endcustomer.subscription.updatedcustomer.tax_id.createdcustomer.tax_id.deletedcustomer.tax_id.updatedcustomer.updatedfile.createdinvoice.createdinvoice.deletedinvoice.finalizedinvoice.marked_uncollectibleinvoice.paidinvoice.payment_action_requiredinvoice.payment_failedinvoice.payment_succeededinvoice.sentinvoice.upcominginvoice.updatedinvoice.voidedinvoiceitem.createdinvoiceitem.deletedinvoiceitem.updatedissuing_authorization.createdissuing_authorization.requestissuing_authorization.updatedissuing_card.createdissuing_card.updatedissuing_cardholder.createdissuing_cardholder.updatedissuing_dispute.createdissuing_dispute.funds_reinstatedissuing_dispute.updatedissuing_transaction.createdissuing_transaction.updatedmandate.updatedorder.createdorder.payment_failedorder.payment_succeededorder.updatedorder_return.createdpayment_intent.amount_capturable_updatedpayment_intent.canceledpayment_intent.createdpayment_intent.payment_failedpayment_intent.processingpayment_intent.succeededpayment_method.attachedpayment_method.card_automatically_updatedpayment_method.detachedpayment_method.updatedpayout.canceledpayout.createdpayout.failedpayout.paidpayout.updatedperson.createdperson.deletedperson.updatedplan.createdplan.deletedplan.updatedprice.createdprice.deletedprice.updatedproduct.createdproduct.deletedproduct.updatedradar.early_fraud_warning.createdradar.early_fraud_warning.updatedrecipient.createdrecipient.deletedrecipient.updatedreporting.report_run.failedreporting.report_run.succeededreporting.report_type.updatedreview.closedreview.openedsetup_intent.canceledsetup_intent.createdsetup_intent.setup_failedsetup_intent.succeededsigma.scheduled_query_run.createdsku.createdsku.deletedsku.updatedsource.canceledsource.chargeablesource.failedsource.mandate_notificationsource.refund_attributes_requiredsource.transaction.createdsource.transaction.updatedsubscription_schedule.abortedsubscription_schedule.canceledsubscription_schedule.completedsubscription_schedule.createdsubscription_schedule.expiringsubscription_schedule.releasedsubscription_schedule.updatedtax_rate.createdtax_rate.updatedtopup.canceledtopup.createdtopup.failedtopup.reversedtopup.succeededtransfer.createdtransfer.failedtransfer.paidtransfer.reversedtransfer.updated`

Trigger Authentication#

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

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

Create a Stripe API key
Click "Create Restricted Key"
Enter the Restricted API key below.

To help ensure proper security, we recommend you create a Restricted key with scopes relevant to the specific operations you will use in Pipedream.

About Stripe#

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

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

Other Popular Integrations#

Create Project Backup with ClickHelp API on New Abandoned Cart from Stripe API

Stripe + ClickHelp

Create Topic with ClickHelp API on New Custom Webhook Events from Stripe API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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