Create Comment with Canny API

Pipedream makes it easy to connect APIs for Canny and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Comment with the Canny 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#

Create a workflow to Create Comment with the Canny API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Comment action
1. Connect your Canny account
2. Select a Author ID
3. Select a Post ID
4. Optional- Configure Value
5. Optional- Configure Image URLs
6. Optional- Select a Parent ID
7. Optional- Configure Should Notify Voters
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Comment on Canny

Description:Create a comment. [See the documentation](https://developers.canny.io/api-reference#create_comment)

Version:0.0.1

Key:canny-create-comment

View on GitHub

Code#

import canny from "../../canny.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "canny-create-comment",
  name: "Create Comment",
  description: "Create a comment. [See the documentation](https://developers.canny.io/api-reference#create_comment)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    canny,
    authorId: {
      propDefinition: [
        canny,
        "userId",
      ],
      label: "Author ID",
      description: "The ID of the author of the comment",
    },
    postId: {
      propDefinition: [
        canny,
        "postId",
      ],
      description: "The ID of the post to comment on",
    },
    value: {
      type: "string",
      label: "Value",
      description: "The comment value. Optional if imageURLs are provided. Must be under 2500 characters.",
      optional: true,
    },
    imageUrls: {
      type: "string[]",
      label: "Image URLs",
      description: "An array of the URLs of comment's images",
      optional: true,
    },
    parentId: {
      propDefinition: [
        canny,
        "commentId",
      ],
      label: "Parent ID",
      description: "The ID of the parent comment",
      optional: true,
    },
    shouldNotifyVoters: {
      type: "boolean",
      label: "Should Notify Voters",
      description: "Whether this comment should be allowed to trigger email notifications. Default is false.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.value && !this.imageUrls) {
      throw new ConfigurationError("Either value or imageUrls must be provided");
    }

    const response = await this.canny.createComment({
      $,
      data: {
        authorID: this.authorId,
        postID: this.postId,
        value: this.value,
        imageURLs: this.imageUrls,
        parentID: this.parentId,
        shouldNotifyVoters: this.shouldNotifyVoters,
      },
    });
    $.export("$summary", `Successfully created comment with ID ${response.id}`);
    return response;
  },
};

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
Canny	`canny`	`app`	This component uses the Canny app.
Author ID	`authorId`	`string`	Select a value from the drop down menu.
Post ID	`postId`	`string`	Select a value from the drop down menu.
Value	`value`	`string`	The comment value. Optional if imageURLs are provided. Must be under 2500 characters.
Image URLs	`imageUrls`	`string[]`	An array of the URLs of comment's images
Parent ID	`parentId`	`string`	Select a value from the drop down menu.
Should Notify Voters	`shouldNotifyVoters`	`boolean`	Whether this comment should be allowed to trigger email notifications. Default is false.

Authentication#

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

API requests must be authenticated by including your secret API key. You can find your secret API key in Your Canny Subdomain > Settings > Integrations > API & Webhooks. This key is secret, so be careful not to share it publicly and don't store it in the client side of your app.