Freshservice¶

Node: freshservice · Full type: n8n-nodes-base.freshservice · Version: 1

Credentials¶

freshserviceApi (alias: @freshservice)

CREDENTIAL @freshservice = freshserviceApi "My Freshservice"

Operations¶

Resource: `agent`¶

`create`¶

Parameter	Type	Default	Details
`email`	string	""	required
`firstName`	string	""	required
`roles`	fixedCollection	{}	required; groups: `roleProperties`
`additionalFields`	collection	{}	keys: `address`, `background_information`, `department_ids`, `job_title`, `language`, `last_name`, ...

`delete`¶

Parameter	Type	Default	Details
`agentId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`agentId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	collection	{}	keys: `department_id`, `email`, `first_name`, `job_title`, `language`, `last_name`, ...

`update`¶

Parameter	Type	Default	Details
`agentId`	string	""	required
`updateFields`	collection	{}	keys: `address`, `background_information`, `department_ids`, `email`, `first_name`, `job_title`, ...

Resource: `agentGroup`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`, `escalate_to`, `members`, `observers`, `unassigned_for`

`delete`¶

Parameter	Type	Default	Details
`agentGroupId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`agentGroupId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`agentGroupId`	string	""	required
`updateFields`	collection	{}	keys: `description`, `escalate_to`, `members`, `name`, `observers`, `unassigned_for`

Resource: `agentRole`¶

`get`¶

Parameter	Type	Default	Details
`agentRoleId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

Resource: `announcement`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`bodyHtml`	string	""	required
`visibility`	options	"everyone"	required; `agents_only`, `grouped_visibility`, `everyone`
`visibleFrom`	dateTime	""	required
`additionalFields`	collection	{}	keys: `additional_emails`, `departments`, `visible_from`, `visible_till`

`delete`¶

Parameter	Type	Default	Details
`announcementId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`announcementId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`announcementId`	string	""	required
`updateFields`	collection	{}	keys: `additional_emails`, `body_html`, `departments`, `title`, `visibility`

Resource: `assetType`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`, `parent_asset_type_id`

`delete`¶

Parameter	Type	Default	Details
`assetTypeId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`assetTypeId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`assetTypeId`	string	""	required
`updateFields`	collection	{}	keys: `description`, `name`

Resource: `change`¶

`create`¶

Parameter	Type	Default	Details
`requesterId`	options	""	required
`subject`	string	""	required
`plannedStartDate`	dateTime	""	required
`plannedEndDate`	dateTime	""	required
`additionalFields`	collection	{}	keys: `agent_id`, `change_type`, `department_id`, `description`, `group_id`, `impact`, ...

`delete`¶

Parameter	Type	Default	Details
`changeId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`changeId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	collection	{}	keys: `filter`, `sort_by`, `updated_since`

`update`¶

Parameter	Type	Default	Details
`changeId`	string	""	required
`updateFields`	collection	{}	keys: `agent_id`, `change_type`, `department_id`, `description`, `group_id`, `impact`, ...

Resource: `department`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`, `domains`

`delete`¶

Parameter	Type	Default	Details
`departmentId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`departmentId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	collection	{}	keys: `name`

`update`¶

Parameter	Type	Default	Details
`departmentId`	string	""	required
`updateFields`	collection	{}	keys: `description`, `domains`, `name`

Resource: `location`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `address`

`delete`¶

Parameter	Type	Default	Details
`locationId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`locationId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`locationId`	string	""	required
`updateFields`	collection	{}	keys: `name`, `address`

Resource: `problem`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`requesterId`	options	""	required
`dueBy`	dateTime	""
`additionalFields`	collection	{}	keys: `agent_id`, `department_id`, `description`, `group_id`, `impact`, `priority`, ...

`delete`¶

Parameter	Type	Default	Details
`problemId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`problemId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`problemId`	string	""	required
`updateFields`	collection	{}	keys: `agent_id`, `department_id`, `description`, `due_by`, `group_id`, `impact`, ...

Resource: `product`¶

`create`¶

Parameter	Type	Default	Details
`assetTypeId`	options	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`, `manufacturer`, `mode_of_procurement`, `status`

`delete`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`productId`	string	""	required
`updateFields`	collection	{}	keys: `asset_type_id`, `description`, `manufacturer`, `mode_of_procurement`, `name`, `status`

Resource: `release`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`releaseType`	options	1	`1`, `2`, `3`, `4`
`priority`	options	1	`1`, `2`, `3`, `4`
`status`	options	1	`1`, `2`, `3`, `4`, `5`
`plannedStartDate`	dateTime	""	required
`plannedEndDate`	dateTime	""	required
`additionalFields`	collection	{}	keys: `department_id`, `description`, `group_id`

`delete`¶

Parameter	Type	Default	Details
`releaseId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`releaseId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`releaseId`	string	""	required
`updateFields`	collection	{}	keys: `department_id`, `description`, `group_id`, `priority`, `release_type`, `status`, ...

Resource: `requester`¶

`create`¶

Parameter	Type	Default	Details
`firstName`	string	""	required
`primaryEmail`	string	""
`additionalFields`	collection	{}	keys: `address`, `background_information`, `department_ids`, `job_title`, `language`, `last_name`, ...

`delete`¶

Parameter	Type	Default	Details
`requesterId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`requesterId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	collection	{}	keys: `department_id`, `first_name`, `job_title`, `language`, `last_name`, `location_id`, ...

`update`¶

Parameter	Type	Default	Details
`requesterId`	string	""	required
`updateFields`	collection	{}	keys: `address`, `background_information`, `department_ids`, `first_name`, `job_title`, `language`, ...

Resource: `requesterGroup`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`

`delete`¶

Parameter	Type	Default	Details
`requesterGroupId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`requesterGroupId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`requesterGroupId`	string	""	required
`updateFields`	collection	{}	keys: `description`, `name`

Resource: `software`¶

`create`¶

Parameter	Type	Default	Details
`applicationType`	options	"desktop"	required; `desktop`, `mobile`, `saas`
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`, `notes`, `status`

`delete`¶

Parameter	Type	Default	Details
`softwareId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`softwareId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`softwareId`	string	""	required
`updateFields`	collection	{}	keys: `application_type`, `description`, `name`, `notes`, `status`

Resource: `ticket`¶

`create`¶

Parameter	Type	Default	Details
`email`	string	""	required
`subject`	string	""
`description`	string	""
`priority`	options	1	`1`, `2`, `3`, `4`
`status`	options	2	`2`, `3`, `4`, `5`
`additionalFields`	collection	{}	keys: `cc_emails`, `department_id`, `group_id`, `impact`, `name`, `requester_id`

`delete`¶

Parameter	Type	Default	Details
`ticketId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`ticketId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	collection	{}	keys: `agent_id`, `group_id`, `impact`, `priority`, `status`, `created_at`, ...

`update`¶

Parameter	Type	Default	Details
`ticketId`	string	""	required
`updateFields`	collection	{}	keys: `department_id`, `description`, `email`, `group_id`, `impact`, `name`, ...

Parameter Details¶

roles children:

roleProperties group:

Parameter	Type	Default	Details
`role`	options	""	required
`assignment_scope`	options	"specified_groups"	required; `entire_helpdesk`, `member_groups`, `specified_groups`, `assigned_items`
`groups`	multiOptions	[]

additionalFields children:

Parameter	Type	Default	Details
`address`	string	""
`background_information`	string	""
`department_ids`	multiOptions	[]
`job_title`	string	""
`language`	options	""	`en`, `ar`, `ca`, `cs`, `cy-GB`, `da`, `de`, `es`, ... (36 total)
`last_name`	string	""
`location_id`	options	""
`member_of`	multiOptions	[]
`mobile_phone_number`	string	""
`observer_of`	multiOptions	[]
`scoreboard_level_id`	options	1	`1`, `2`, `3`, `4`, `5`, `6`
`time_format`	options	"12h"	`12h`, `24h`
`work_phone_number`	string	""

filters children:

Parameter	Type	Default	Details
`department_id`	options	""
`email`	string	""
`first_name`	string	""
`job_title`	string	""
`language`	options	""	`en`, `ar`, `ca`, `cs`, `cy-GB`, `da`, `de`, `es`, ... (36 total)
`last_name`	string	""
`location_id`	options	""
`mobile_phone_number`	string	""
`work_phone_number`	string	""

updateFields children:

Parameter	Type	Default	Details
`address`	string	""
`background_information`	string	""
`department_ids`	multiOptions	[]
`email`	string	""
`first_name`	string	""
`job_title`	string	""
`language`	options	""	`en`, `ar`, `ca`, `cs`, `cy-GB`, `da`, `de`, `es`, ... (36 total)
`last_name`	string	""
`location_id`	options	""
`member_of`	multiOptions	[]
`mobile_phone_number`	string	""
`observer_of`	multiOptions	[]
`scoreboard_level_id`	options	1	`1`, `2`, `3`, `4`, `5`, `6`
`time_format`	options	"12h"	`12h`, `24h`
`work_phone_number`	string	""

Example¶

NODE "freshservice" @freshservice AS "Freshservice" {
  resource: "agent",
  operation: "get",
  email: {{ $json.email }},
  firstName: {{ $json.firstName }},
  agentId: {{ $json.agentId }}
}

Freshservice¶

Credentials¶

Operations¶

Resource: agent¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: agentGroup¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: agentRole¶

get¶

getAll¶

Resource: announcement¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: assetType¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: change¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: department¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: location¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: problem¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: product¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: release¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: requester¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: requesterGroup¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: software¶

create¶

Resource: `agent`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `agentGroup`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `agentRole`¶

`get`¶

`getAll`¶

Resource: `announcement`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `assetType`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `change`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `department`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `location`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `problem`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `product`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `release`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `requester`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `requesterGroup`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `software`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶