Add Note to Ticket with Freshdesk API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Freshdesk, npm and 2,700+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

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

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Add Note to Ticket action
1. Connect your Freshdesk account
2. Select a Ticket ID
3. Configure Note Body
4. Configure Private Note
5. Optional- Configure Incoming
6. Optional- Select a User ID
7. Optional- Configure Notify Emails
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Add Note to Ticket on Freshdesk

Description:Add a note or conversation to an existing ticket. [See the documentation](https://developers.freshdesk.com/api/#add_note_to_a_ticket).

Version:0.0.1

Key:freshdesk-add-note-to-ticket

View on GitHub

Freshdesk Overview#

The Freshdesk API empowers you to interact programmatically with your customer support platform, creating possibilities for automating repetitive tasks, integrating with other services, and enhancing customer experiences. With Pipedream, you can effortlessly connect Freshdesk to a multitude of apps, tapping into triggers and actions that streamline workflows. For instance, you can automate ticket creation, sync customer issues with a CRM, or trigger notifications based on ticket updates, all within a serverless environment.

Action Code#

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

export default {
  key: "freshdesk-add-note-to-ticket",
  name: "Add Note to Ticket",
  description: "Add a note or conversation to an existing ticket. [See the documentation](https://developers.freshdesk.com/api/#add_note_to_a_ticket).",
  version: "0.0.1",
  type: "action",
  props: {
    freshdesk,
    ticketId: {
      propDefinition: [
        freshdesk,
        "ticketId",
      ],
    },
    body: {
      type: "string",
      label: "Note Body",
      description: "Content of the note in HTML format",
    },
    private: {
      type: "boolean",
      label: "Private Note",
      description: "Set to true if the note is private (internal)",
      default: false,
    },
    incoming: {
      type: "boolean",
      label: "Incoming",
      description: "Set to true if the note should be marked as incoming (false for outgoing)",
      default: false,
      optional: true,
    },
    user_id: {
      propDefinition: [
        freshdesk,
        "agentId",
      ],
      label: "User ID",
      description: "ID of the user creating the note (defaults to the API user)",
      optional: true,
    },
    notify_emails: {
      type: "string[]",
      label: "Notify Emails",
      description: "Array of email addresses to notify about this note",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      freshdesk,
      ticketId,
      body,
      private: isPrivate,
      incoming,
      user_id,
      notify_emails,
    } = this;

    if (!body || !body.trim()) {
      throw new ConfigurationError("Note body cannot be empty");
    }

    const ticketName = await freshdesk.getTicketName(ticketId) || "Unknown Ticket";

    const data = {
      body,
      private: isPrivate,
    };

    if (incoming !== undefined) {
      data.incoming = incoming;
    }

    if (user_id) {
      const userId = Number(user_id);
      if (isNaN(userId)) {
        throw new ConfigurationError("User ID must be a valid number");
      }
      data.user_id = userId;
    }

    if (notify_emails && notify_emails.length > 0) {
      const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
      const invalidEmails = notify_emails.filter((email) => !emailRegex.test(email));
      if (invalidEmails.length > 0) {
        throw new ConfigurationError(`Invalid email addresses: ${invalidEmails.join(", ")}`);
      }
      data.notify_emails = notify_emails;
    }

    const response = await freshdesk.addNoteToTicket({
      $,
      ticketId: Number(ticketId),
      data,
    });

    $.export("$summary", `Note added to ticket "${ticketName}" (ID: ${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
Freshdesk	`freshdesk`	`app`	This component uses the Freshdesk app.
Ticket ID	`ticketId`	`integer`	Select a value from the drop down menu.
Note Body	`body`	`string`	Content of the note in HTML format
Private Note	`private`	`boolean`	Set to true if the note is private (internal)
Incoming	`incoming`	`boolean`	Set to true if the note should be marked as incoming (false for outgoing)
User ID	`user_id`	`integer`	Select a value from the drop down menu.
Notify Emails	`notify_emails`	`string[]`	Array of email addresses to notify about this note