Update Ticket Field with Freshdesk API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Ticket Field 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 Update Ticket Field with the Freshdesk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Ticket Field action
1. Connect your Freshdesk account
2. Select a Ticket Field ID
3. Optional- Configure Label
4. Optional- Configure Label for Customers
5. Optional- Configure Customers Can Edit
6. Optional- Configure Displayed to Customers
7. Optional- Configure Position
8. Optional- Configure Required for Closure
9. Optional- Configure Required for Agents
10. Optional- Configure Required for Customers
11. Optional- Configure Choices
12. Optional- Configure Dependent Fields
13. Optional- Configure Section Mappings
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#

Update Ticket Field with Freshdesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Freshdesk

Try it

Update Ticket Field with Freshdesk API on New Submission from Typeform API

Typeform + Freshdesk

Try it

Update Ticket Field with Freshdesk API on New Submission (Instant) from Jotform API

Jotform + Freshdesk

Try it

Update Ticket Field with Freshdesk API on New Scheduled Tasks from Pipedream API

Pipedream + Freshdesk

Try it

Update Ticket Field 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.

Update Ticket Field on Freshdesk

Description:Update a ticket field in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#update_ticket_field)

Version:0.0.1

Key:freshdesk-update-ticket-field

View on GitHub

Code#

import freshdesk from "../../freshdesk.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "freshdesk-update-ticket-field",
  name: "Update Ticket Field",
  description: "Update a ticket field in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#update_ticket_field)",
  version: "0.0.1",
  type: "action",
  props: {
    freshdesk,
    ticketFieldId: {
      propDefinition: [
        freshdesk,
        "ticketFieldId",
      ],
    },
    label: {
      type: "string",
      label: "Label",
      description: "Display the name of the Ticket Field",
      optional: true,
    },
    labelForCustomers: {
      type: "string",
      label: "Label for Customers",
      description: "The label for the field as seen by customers",
      optional: true,
    },
    customersCanEdit: {
      type: "boolean",
      label: "Customers Can Edit",
      description: "Whether customers can edit the field",
      optional: true,
    },
    displayedToCustomers: {
      type: "boolean",
      label: "Displayed to Customers",
      description: "Whether the field is displayed to customers",
      optional: true,
    },
    position: {
      type: "integer",
      label: "Position",
      description: "The position of the fieldPosition in which the ticket field is displayed in the form. If not given, it will be displayed on top",
      optional: true,
    },
    requiredForClosure: {
      type: "boolean",
      label: "Required for Closure",
      description: "Set to `true` if the field is mandatory for closing the ticket",
      optional: true,
    },
    requiredForAgents: {
      type: "boolean",
      label: "Required for Agents",
      description: "Set to `true` if the field is mandatory for agents",
      optional: true,
    },
    requiredForCustomers: {
      type: "boolean",
      label: "Required for Customers",
      description: "Set to `true` if the field is mandatory for customers",
      optional: true,
    },
    choices: {
      type: "string[]",
      label: "Choices",
      description: "Array of key, value pairs containing the value and position of dropdown choices. Example: `[{ \"value\": \"Refund\", \"position\": 1 }, { \"value\": \"FaultyProduct\", \"position\": 2 }]`",
      optional: true,
    },
    dependentFields: {
      type: "string[]",
      label: "Dependent Fields",
      description: "Applicable only for dependent fields, this contains details of nested fields Example: `[{ \"label\": \"District\", \"label_for_customers\": \"District\", \"level\": 2 }, { \"label\": \"Branch\", \"label_for_customers\": \"Branch\", \"level\": 3 }]`",
      optional: true,
    },
    sectionMappings: {
      type: "string[]",
      label: "Section Mappings",
      description: "Applicable only if the field is part of a section. This contains the details of a section (ID, position) for which it is been a part of. Example: `[{ \"position\": 3, \"section_id\": 1 }]`",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.freshdesk.updateTicketField({
      $,
      ticketFieldId: this.ticketFieldId,
      data: {
        label: this.label,
        label_for_customers: this.labelForCustomers,
        customers_can_edit: this.customersCanEdit,
        displayed_to_customers: this.displayedToCustomers,
        position: this.position,
        required_for_closure: this.requiredForClosure,
        required_for_agents: this.requiredForAgents,
        required_for_customers: this.requiredForCustomers,
        choices: parseObject(this.choices),
        dependent_fields: parseObject(this.dependentFields),
        section_mappings: parseObject(this.sectionMappings),
      },
    });
    $.export("$summary", `Successfully updated ticket field: ${response.label}`);
    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 Field ID	`ticketFieldId`	`string`	Select a value from the drop down menu.
Label	`label`	`string`	Display the name of the Ticket Field
Label for Customers	`labelForCustomers`	`string`	The label for the field as seen by customers
Customers Can Edit	`customersCanEdit`	`boolean`	Whether customers can edit the field
Displayed to Customers	`displayedToCustomers`	`boolean`	Whether the field is displayed to customers
Position	`position`	`integer`	The position of the fieldPosition in which the ticket field is displayed in the form. If not given, it will be displayed on top
Required for Closure	`requiredForClosure`	`boolean`	Set to `true` if the field is mandatory for closing the ticket
Required for Agents	`requiredForAgents`	`boolean`	Set to `true` if the field is mandatory for agents
Required for Customers	`requiredForCustomers`	`boolean`	Set to `true` if the field is mandatory for customers
Choices	`choices`	`string[]`	Array of key, value pairs containing the value and position of dropdown choices. Example: `[{ "value": "Refund", "position": 1 }, { "value": "FaultyProduct", "position": 2 }]`
Dependent Fields	`dependentFields`	`string[]`	Applicable only for dependent fields, this contains details of nested fields Example: `[{ "label": "District", "label_for_customers": "District", "level": 2 }, { "label": "Branch", "label_for_customers": "Branch", "level": 3 }]`
Section Mappings	`sectionMappings`	`string[]`	Applicable only if the field is part of a section. This contains the details of a section (ID, position) for which it is been a part of. Example: `[{ "position": 3, "section_id": 1 }]`