View as Markdown
Freshdesk icon

Freshdesk ACTION

Create Ticket Field

Create a ticket field in Freshdesk. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Freshdesk account once, then configure and run Create Ticket Field from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "freshdesk-create-ticket-field",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    freshdesk: { authProvisionId: "apn_xxxxxxx" },
    label: "Label",
    labelForCustomers: "Label for Customers",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Ticket Field inputs
Property Type Description
label Label string
Display the name of the Ticket Field
Required
labelForCustomers Label for Customers string
The label for the field as seen by customers
Required
type Type string
The type of the field. Can be custom_dropdown, custom_checkbox, custom_text, etc...
Required
customersCanEdit Customers Can Edit boolean
Whether customers can edit the field
Optional
displayedToCustomers Displayed to Customers boolean
Whether the field is displayed to customers
Optional
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
Optional
requiredForClosure Required for Closure boolean
Set to true if the field is mandatory for closing the ticket
Optional
requiredForAgents Required for Agents boolean
Set to true if the field is mandatory for agents
Optional
requiredForCustomers Required for Customers boolean
Set to true if the field is mandatory for customers
Optional
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 }]
Optional
dependentFields Dependent Fields 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 }]
Optional
sectionMappings Section Mappings 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 }]
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
freshdesk-create-ticket-field
Version
0.0.10
App
Freshdesk
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes