Add Note to Ticket with Freshdesk API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

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

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

Integrations#

Add Note to Ticket with Freshdesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Freshdesk

Try it

Add Note to Ticket with Freshdesk API on New Submission from Typeform API

Typeform + Freshdesk

Try it

Add Note to Ticket with Freshdesk API on New Submission (Instant) from Jotform API

Jotform + Freshdesk

Try it

Add Note to Ticket with Freshdesk API on New Scheduled Tasks from Pipedream API

Pipedream + Freshdesk

Try it

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

npm + Freshdesk

Try it

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.

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

Key:freshdesk-add-note-to-ticket

View on GitHub

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.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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;
  },
};

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