freshdesk.json•19.4 kB
{
"nodeType": "n8n-nodes-base.freshdesk",
"displayName": "Freshdesk",
"description": "Consume Freshdesk API",
"version": 1,
"properties": [
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of the contact",
"placeholder": "",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"contact"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "Primary email address of the contact. If you want to associate additional email(s) with this contact, use the other_emails attribute.",
"placeholder": "name@email.com",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"contact"
]
}
}
},
{
"name": "contactId",
"displayName": "Contact ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"update"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Address of the contact",
"placeholder": "Add Field",
"options": [
{
"name": "address",
"displayName": "Address",
"type": "string",
"default": "",
"description": "Address of the contact"
},
{
"name": "company_id",
"displayName": "Company ID",
"type": "number",
"default": "",
"description": "ID of the primary company to which this contact belongs"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create",
"update"
],
"resource": [
"contact"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"placeholder": "Add Filter",
"options": [
{
"name": "company_id",
"displayName": "Company ID",
"type": "number",
"default": ""
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"placeholder": "name@email.com"
},
{
"name": "mobile",
"displayName": "Mobile",
"type": "string",
"default": ""
},
{
"name": "phone",
"displayName": "Phone",
"type": "string",
"default": ""
}
],
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"contact"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Create a new contact",
"required": true,
"options": [
{
"name": "Create",
"value": "create",
"description": "Create a new contact"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete a contact"
},
{
"name": "Get",
"value": "get",
"description": "Get a contact"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many contacts"
},
{
"name": "Update",
"value": "update",
"description": "Update a contact"
}
],
"displayOptions": {
"show": {
"resource": [
"contact"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "ticket",
"required": true,
"options": [
{
"name": "Contact",
"value": "contact"
},
{
"name": "Ticket",
"value": "ticket"
}
]
},
{
"name": "requester",
"displayName": "Requester Identification",
"type": "options",
"default": "requesterId",
"description": "Email address of the requester. If no contact exists with this email address in Freshdesk, it will be added as a new contact.",
"required": true,
"options": [
{
"name": "Email",
"value": "email",
"description": "Email address of the requester. If no contact exists with this email address in Freshdesk, it will be added as a new contact."
},
{
"name": "Facebook ID",
"value": "facebookId",
"description": "Facebook ID of the requester. If no contact exists with this facebook_id, then a new contact will be created."
},
{
"name": "Phone",
"value": "phone",
"description": "Phone number of the requester. If no contact exists with this phone number in Freshdesk, it will be added as a new contact. If the phone number is set and the email address is not, then the name attribute is mandatory."
},
{
"name": "Requester ID",
"value": "requesterId",
"description": "User ID of the requester. For existing contacts, the requester_id can be passed instead of the requester's email."
},
{
"name": "Twitter ID",
"value": "twitterId",
"description": "Twitter handle of the requester. If no contact exists with this handle in Freshdesk, it will be added as a new contact."
},
{
"name": "Unique External ID",
"value": "uniqueExternalId",
"description": "External ID of the requester. If no contact exists with this external ID in Freshdesk, they will be added as a new contact."
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "requesterIdentificationValue",
"displayName": "Value",
"type": "string",
"default": "",
"description": "Value of the identification selected",
"required": true,
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "status",
"displayName": "Status",
"type": "options",
"default": "pending",
"required": true,
"options": [
{
"name": "Closed",
"value": "closed"
},
{
"name": "Open",
"value": "open"
},
{
"name": "Pending",
"value": "pending"
},
{
"name": "Resolved",
"value": "resolved"
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "priority",
"displayName": "Priority",
"type": "options",
"default": "low",
"required": true,
"options": [
{
"name": "Low",
"value": "low"
},
{
"name": "Medium",
"value": "medium"
},
{
"name": "High",
"value": "high"
},
{
"name": "Urgent",
"value": "urgent"
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "source",
"displayName": "Source",
"type": "options",
"default": "portal",
"description": "The channel through which the ticket was created",
"required": true,
"options": [
{
"name": "Chat",
"value": "chat"
},
{
"name": "Email",
"value": "email"
},
{
"name": "Feedback Widget",
"value": "feedbackWidget"
},
{
"name": "Mobihelp",
"value": "mobileHelp"
},
{
"name": "Outbound Email",
"value": "OutboundEmail"
},
{
"name": "Phone",
"value": "phone"
},
{
"name": "Portal",
"value": "portal"
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "ID of the agent to whom the ticket has been assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add option",
"options": [
{
"name": "agent",
"displayName": "Agent Name or ID",
"type": "options",
"default": "",
"description": "ID of the agent to whom the ticket has been assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "ccEmails",
"displayName": "CC Emails",
"type": "string",
"default": "",
"description": "Separated by a comma (,) email addresses added in the 'cc' field of the incoming ticket email"
},
{
"name": "company",
"displayName": "Company Name or ID",
"type": "options",
"default": "",
"description": "Company ID of the requester. This attribute can only be set if the Multiple Companies feature is enabled (Estate plan and above). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "HTML content of the ticket"
},
{
"name": "dueBy",
"displayName": "Due By",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes when the ticket is due to be resolved"
},
{
"name": "emailConfigId",
"displayName": "Email Config ID",
"type": "number",
"default": "",
"description": "ID of email config which is used for this ticket. (i.e., support@yourcompany.com/sales@yourcompany.com) If product_id is given and email_config_id is not given, product's primary email_config_id will be set."
},
{
"name": "frDueBy",
"displayName": "FR Due By",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes when the first response is due"
},
{
"name": "group",
"displayName": "Group Name or ID",
"type": "options",
"default": "",
"description": "ID of the group to which the ticket has been assigned. The default value is the ID of the group that is associated with the given email_config_id. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of the requester",
"placeholder": ""
},
{
"name": "product",
"displayName": "Product Name or ID",
"type": "options",
"default": "",
"description": "ID of the product to which the ticket is associated. It will be ignored if the email_config_id attribute is set in the request. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "subject",
"displayName": "Subject",
"type": "string",
"default": "",
"description": "Subject of the ticket",
"placeholder": ""
},
{
"name": "tags",
"displayName": "Tags",
"type": "string",
"default": "",
"description": "Separated by a comma (,) tags that have been associated with the ticket"
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "ticketId",
"displayName": "Ticket ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"update"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "ID of the agent to whom the ticket has been assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add Field",
"options": [
{
"name": "agent",
"displayName": "Agent Name or ID",
"type": "options",
"default": "",
"description": "ID of the agent to whom the ticket has been assigned. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "ccEmails",
"displayName": "CC Emails",
"type": "string",
"default": "",
"description": "Separated by a comma (,) email addresses added in the 'cc' field of the incoming ticket email"
},
{
"name": "company",
"displayName": "Company Name or ID",
"type": "options",
"default": "",
"description": "Company ID of the requester. This attribute can only be set if the Multiple Companies feature is enabled (Estate plan and above). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "dueBy",
"displayName": "Due By",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes when the ticket is due to be resolved"
},
{
"name": "emailConfigId",
"displayName": "Email Config ID",
"type": "number",
"default": "",
"description": "ID of email config which is used for this ticket. (i.e., support@yourcompany.com/sales@yourcompany.com) If product_id is given and email_config_id is not given, product's primary email_config_id will be set."
},
{
"name": "frDueBy",
"displayName": "FR Due By",
"type": "dateTime",
"default": "",
"description": "Timestamp that denotes when the first response is due"
},
{
"name": "group",
"displayName": "Group Name or ID",
"type": "options",
"default": "",
"description": "ID of the group to which the ticket has been assigned. The default value is the ID of the group that is associated with the given email_config_id. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of the requester",
"placeholder": ""
},
{
"name": "product",
"displayName": "Product Name or ID",
"type": "options",
"default": "",
"description": "ID of the product to which the ticket is associated. It will be ignored if the email_config_id attribute is set in the request. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
}
],
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"update"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 5,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 10
},
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
}
],
"credentialsConfig": [
{
"name": "freshdeskApi",
"required": true
},
{
"name": "resource",
"required": true
},
{
"name": "operation",
"required": true
},
{
"name": "requester",
"required": true
},
{
"name": "requesterIdentificationValue",
"required": true
},
{
"name": "priority",
"required": true
},
{
"name": "source",
"required": true
},
{
"name": "jsonParameters",
"required": false
},
{
"name": "customFieldsUi",
"required": false
},
{
"name": "requester",
"required": false
},
{
"name": "requesterIdentificationValue",
"required": false
},
{
"name": "source",
"required": false
},
{
"name": "tags",
"required": false
},
{
"name": "ticketId",
"required": true
},
{
"name": "order",
"required": false
},
{
"name": "orderBy",
"required": false
},
{
"name": "requesterEmail",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}