New Comment Created from Canny API

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

Trigger workflow on

New Comment Created from the Canny API

Next, do this

Connect to 3,000+ APIs using code and no-code building blocks

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#

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

Configure the New Comment Created trigger
1. Connect your Canny account
2. Configure timer
3. Optional- Select a Board ID
4. Optional- Select a User ID
5. Optional- Select a Company ID
6. Optional- Select a Post ID
Add steps to connect to 3,000+ APIs using code and no-code building blocks
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.

New Comment Created on Canny

Description:Emit new event when a new comment is created. [See the documentation](https://developers.canny.io/api-reference#list_comments)

Version:0.0.1

Key:canny-new-comment-created

View on GitHub

Code#

import common from "../common/base-polling.mjs";

export default {
  ...common,
  key: "canny-new-comment-created",
  name: "New Comment Created",
  description: "Emit new event when a new comment is created. [See the documentation](https://developers.canny.io/api-reference#list_comments)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    boardId: {
      propDefinition: [
        common.props.canny,
        "boardId",
      ],
      description: "The ID of the board to watch for new comments",
      optional: true,
    },
    authorId: {
      propDefinition: [
        common.props.canny,
        "userId",
      ],
      description: "Filter comments by author ID",
      optional: true,
    },
    companyId: {
      propDefinition: [
        common.props.canny,
        "companyId",
      ],
      description: "Filter comments by company ID",
      optional: true,
    },
    postId: {
      propDefinition: [
        common.props.canny,
        "postId",
        (c) => ({
          boardId: c.boardId,
        }),
      ],
      description: "Filter comments by post ID",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.canny.listComments;
    },
    getData() {
      return {
        boardID: this.boardId,
        authorID: this.authorId,
        companyID: this.companyId,
        postID: this.postId,
      };
    },
    getResourceKey() {
      return "comments";
    },
    isRelevant(comment) {
      return comment.value || comment.imageURLs.length > 0;
    },
    generateMeta(comment) {
      return {
        id: comment.id,
        summary: `New Comment: ${comment.value}`,
        ts: Date.parse(comment[this.getTsField()]),
      };
    },
  },
};

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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Board ID	`boardId`	`string`	Select a value from the drop down menu.
User ID	`authorId`	`string`	Select a value from the drop down menu.
Company ID	`companyId`	`string`	Select a value from the drop down menu.
Post ID	`postId`	`string`	Select a value from the drop down menu.

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.