Add Ticket Tags with Zendesk API on New Comment Created from Canny API

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

Trigger workflow on

New Comment Created from the Canny API

Next, do this

Add Ticket Tags with the Zendesk 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 Canny trigger and Zendesk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
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
Configure the Add Ticket Tags action
1. Connect your Zendesk account
2. Select a Ticket ID
3. Optional- Configure Tags
4. Optional- Configure Custom Subdomain
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 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

Canny Overview#

The Canny API provides programmatic access to Canny's customer feedback management platform. With it, you can automate the collection, analysis, and response to user feedback. This includes creating posts, voting on behalf of users, fetching boards, and managing comments and tags. Such integrations can streamline how you gather insights and act on user suggestions, making sure the voice of the customer is heard and addressed efficiently.

Trigger 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()]),
      };
    },
  },
};

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

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

About Canny#

Canny helps you collect and organize feature requests to better understand customer needs and prioritize your roadmap.

Action#

Add Ticket Tags on Zendesk

Description:Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).

Version:0.0.7

Key:zendesk-add-ticket-tags

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Action Code#

import app from "../../zendesk.app.mjs";

export default {
  key: "zendesk-add-ticket-tags",
  name: "Add Ticket Tags",
  description: "Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).",
  type: "action",
  version: "0.0.7",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    ticketTags: {
      propDefinition: [
        app,
        "ticketTags",
      ],
      description: "Array of tags to add to the ticket. These will be appended to any existing tags.",
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      ticketTags,
      customSubdomain,
    } = this;

    const response = await this.app.addTicketTags({
      step,
      ticketId,
      tags: ticketTags,
      customSubdomain,
    });

    step.export("$summary", `Successfully added ${ticketTags.length} tag(s) to ticket ${ticketId}`);
    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
Zendesk	`app`	`app`	This component uses the Zendesk app.
Ticket ID	`ticketId`	`string`	Select a value from the drop down menu.
Tags	`ticketTags`	`string[]`	Array of tags to add to the ticket. These will be appended to any existing tags.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`

Action Authentication#

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

Add Ticket Tags with Zendesk API on New Comment Created from Canny API

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

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular