freshservice.json•21.5 kB
{
"nodeType": "n8n-nodes-base.freshservice",
"displayName": "Freshservice",
"description": "Consume the Freshservice API",
"version": 1,
"properties": [
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"placeholder": "name@email.com",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"create"
]
}
}
},
{
"name": "firstName",
"displayName": "First Name",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"create"
]
}
}
},
{
"name": "roles",
"displayName": "Roles",
"type": "fixedCollection",
"default": {},
"description": "Role to assign to the agent",
"placeholder": "Add Role",
"required": true,
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "IDs of the departments to which the agent belongs. Choose from the list or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add Field",
"options": [
{
"name": "address",
"displayName": "Address",
"type": "string",
"default": ""
},
{
"name": "background_information",
"displayName": "Background Information",
"type": "string",
"default": ""
}
],
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"create"
]
}
}
},
{
"name": "agentId",
"displayName": "Agent ID",
"type": "string",
"default": "",
"description": "ID of the agent to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"delete"
]
}
}
},
{
"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": [
"agent"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "ID of the department to which the agent belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add Filter",
"options": [
{
"name": "department_id",
"displayName": "Department Name or ID",
"type": "options",
"default": "",
"description": "ID of the department to which the agent belongs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"placeholder": "name@email.com"
},
{
"name": "first_name",
"displayName": "First Name",
"type": "string",
"default": ""
},
{
"name": "job_title",
"displayName": "Job Title",
"type": "string",
"default": ""
},
{
"name": "language",
"displayName": "Language",
"type": "options",
"default": ""
},
{
"name": "last_name",
"displayName": "Last Name",
"type": "string",
"default": ""
},
{
"name": "location_id",
"displayName": "Location Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list or specify an ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "mobile_phone_number",
"displayName": "Mobile Phone Number",
"type": "string",
"default": ""
},
{
"name": "work_phone_number",
"displayName": "Work Phone Number",
"type": "string",
"default": ""
}
],
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "IDs of the departments to which the agent belongs. Choose from the list or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add Field",
"options": [
{
"name": "address",
"displayName": "Address",
"type": "string",
"default": ""
},
{
"name": "background_information",
"displayName": "Background Information",
"type": "string",
"default": ""
}
],
"displayOptions": {
"show": {
"resource": [
"agent"
],
"operation": [
"update"
]
}
}
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agentGroup"
],
"operation": [
"create"
]
}
}
},
{
"name": "agentGroupId",
"displayName": "Agent Group ID",
"type": "string",
"default": "",
"description": "ID of the agent group to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agentGroup"
],
"operation": [
"delete"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Create an agent group",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create an agent group"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete an agent group"
},
{
"name": "Get",
"value": "get",
"description": "Retrieve an agent group"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Retrieve many agent groups"
},
{
"name": "Update",
"value": "update",
"description": "Update an agent group"
}
],
"displayOptions": {
"show": {
"resource": [
"agentGroup"
]
}
}
},
{
"name": "agentRoleId",
"displayName": "Agent Role ID",
"type": "string",
"default": "",
"description": "ID of the agent role to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"agentRole"
],
"operation": [
"get"
]
}
}
},
{
"name": "title",
"displayName": "Title",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"announcement"
],
"operation": [
"create"
]
}
}
},
{
"name": "bodyHtml",
"displayName": "Body",
"type": "string",
"default": "",
"description": "HTML supported",
"required": true,
"displayOptions": {
"show": {
"resource": [
"announcement"
],
"operation": [
"create"
]
}
}
},
{
"name": "visibility",
"displayName": "Visibility",
"type": "options",
"default": "everyone",
"required": true,
"options": [
{
"name": "Agents Only",
"value": "agents_only"
},
{
"name": "Agents and Groups",
"value": "grouped_visibility"
},
{
"name": "Everyone",
"value": "everyone"
}
],
"displayOptions": {
"show": {
"resource": [
"announcement"
],
"operation": [
"create"
]
}
}
},
{
"name": "visibleFrom",
"displayName": "Visible From",
"type": "dateTime",
"default": "",
"description": "Timestamp at which announcement becomes active",
"required": true,
"displayOptions": {
"show": {
"resource": [
"announcement"
],
"operation": [
"create"
]
}
}
},
{
"name": "announcementId",
"displayName": "Announcement ID",
"type": "string",
"default": "",
"description": "ID of the announcement to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"announcement"
],
"operation": [
"delete"
]
}
}
},
{
"name": "assetTypeId",
"displayName": "Asset Type ID",
"type": "string",
"default": "",
"description": "ID of the asset type to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"assetType"
],
"operation": [
"delete"
]
}
}
},
{
"name": "requesterId",
"displayName": "Requester Name or ID",
"type": "options",
"default": "",
"description": "ID of the requester of the change. Choose from the list or specify an ID. You can also specify the ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"change"
],
"operation": [
"create"
]
}
}
},
{
"name": "subject",
"displayName": "Subject",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"change"
],
"operation": [
"create"
]
}
}
},
{
"name": "plannedStartDate",
"displayName": "Planned Start Date",
"type": "dateTime",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"change"
],
"operation": [
"create"
]
}
}
},
{
"name": "plannedEndDate",
"displayName": "Planned End Date",
"type": "dateTime",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"change"
],
"operation": [
"create"
]
}
}
},
{
"name": "changeId",
"displayName": "Change ID",
"type": "string",
"default": "",
"description": "ID of the change to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"change"
],
"operation": [
"delete"
]
}
}
},
{
"name": "departmentId",
"displayName": "Department ID",
"type": "string",
"default": "",
"description": "ID of the department to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"department"
],
"operation": [
"delete"
]
}
}
},
{
"name": "locationId",
"displayName": "Location ID",
"type": "string",
"default": "",
"description": "ID of the location to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"location"
],
"operation": [
"delete"
]
}
}
},
{
"name": "dueBy",
"displayName": "Due By",
"type": "dateTime",
"default": "",
"description": "Date when the problem is due to be solved",
"displayOptions": {
"show": {
"resource": [
"problem"
],
"operation": [
"create"
]
}
}
},
{
"name": "problemId",
"displayName": "Problem ID",
"type": "string",
"default": "",
"description": "ID of the problem to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"problem"
],
"operation": [
"delete"
]
}
}
},
{
"name": "productId",
"displayName": "Product ID",
"type": "string",
"default": "",
"description": "ID of the product to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"product"
],
"operation": [
"delete"
]
}
}
},
{
"name": "releaseType",
"displayName": "Release Type",
"type": "options",
"default": 1,
"options": [
{
"name": "Minor",
"value": 1
},
{
"name": "Standard",
"value": 2
},
{
"name": "Major",
"value": 3
},
{
"name": "Emergency",
"value": 4
}
],
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"create"
]
}
}
},
{
"name": "priority",
"displayName": "Priority",
"type": "options",
"default": 1,
"options": [
{
"name": "Low",
"value": 1
},
{
"name": "Medium",
"value": 2
},
{
"name": "High",
"value": 3
},
{
"name": "Urgent",
"value": 4
}
],
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"create"
]
}
}
},
{
"name": "status",
"displayName": "Status",
"type": "options",
"default": 1,
"options": [
{
"name": "Open",
"value": 1
},
{
"name": "On Hold",
"value": 2
},
{
"name": "In Progress",
"value": 3
},
{
"name": "Incomplete",
"value": 4
},
{
"name": "Completed",
"value": 5
}
],
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"create"
]
}
}
},
{
"name": "releaseId",
"displayName": "Release ID",
"type": "string",
"default": "",
"description": "ID of the release to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"delete"
]
}
}
},
{
"name": "primaryEmail",
"displayName": "Primary Email",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"requester"
],
"operation": [
"create"
]
}
}
},
{
"name": "requesterGroupId",
"displayName": "Requester Group ID",
"type": "string",
"default": "",
"description": "ID of the requester group to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"requesterGroup"
],
"operation": [
"delete"
]
}
}
},
{
"name": "applicationType",
"displayName": "Application Type",
"type": "options",
"default": "desktop",
"required": true,
"options": [
{
"name": "Desktop",
"value": "desktop"
},
{
"name": "Mobile",
"value": "mobile"
},
{
"name": "SaaS",
"value": "saas"
}
],
"displayOptions": {
"show": {
"resource": [
"software"
],
"operation": [
"create"
]
}
}
},
{
"name": "softwareId",
"displayName": "Software ID",
"type": "string",
"default": "",
"description": "ID of the software application to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"software"
],
"operation": [
"delete"
]
}
}
},
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "HTML supported",
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"create"
]
}
}
},
{
"name": "ticketId",
"displayName": "Ticket ID",
"type": "string",
"default": "",
"description": "ID of the ticket to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"ticket"
],
"operation": [
"delete"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "agent",
"options": [
{
"name": "Agent",
"value": "agent"
},
{
"name": "Agent Group",
"value": "agentGroup"
},
{
"name": "Agent Role",
"value": "agentRole"
},
{
"name": "Announcement",
"value": "announcement"
},
{
"name": "Asset Type",
"value": "assetType"
},
{
"name": "Change",
"value": "change"
},
{
"name": "Department",
"value": "department"
},
{
"name": "Location",
"value": "location"
},
{
"name": "Problem",
"value": "problem"
},
{
"name": "Product",
"value": "product"
},
{
"name": "Release",
"value": "release"
},
{
"name": "Requester",
"value": "requester"
},
{
"name": "Requester Group",
"value": "requesterGroup"
},
{
"name": "Software",
"value": "software"
},
{
"name": "Ticket",
"value": "ticket"
}
]
}
],
"credentialsConfig": [
{
"name": "freshserviceApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}