Skip to content

[ACTIONS] Freshdesk. Add update-ticket and SET actions #16450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import freshdesk from "../../freshdesk.app.mjs";

export default {
key: "freshdesk-assign-ticket-to-agent",
name: "Assign Ticket to Agent",
description: "Assign a Freshdesk ticket to a specific agent. [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
responder_id: {
propDefinition: [
freshdesk,
"agentId",
],
},
},
async run({ $ }) {

const ticketName = await this.freshdesk.getTicketName(this.ticketId);

const response = await this.freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${this.ticketId}`,
data: {
responder_id: this.responder_id,
},
});
$.export("$summary",
`Ticket "${ticketName}" (ID: ${this.ticketId}) assigned to agent ${this.responder_id}`);

return response;
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import freshdesk from "../../freshdesk.app.mjs";

export default {
key: "freshdesk-assign-ticket-to-group",
name: "Assign Ticket to Group",
description: "Assign a Freshdesk ticket to a specific group [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
group_id: {
propDefinition: [
freshdesk,
"groupId",
],
},
},
async run({ $ }) {

const ticketName = await this.freshdesk.getTicketName(this.ticketId);

const response = await this.freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${this.ticketId}`,
data: {
group_id: this.group_id,
},
});

$.export("$summary",
`Ticket "${ticketName}" (ID: ${this.ticketId}) assigned to group ${this.group_id}`);

return response;
},
};
33 changes: 33 additions & 0 deletions components/freshdesk/actions/close-ticket/close-ticket.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import freshdesk from "../../freshdesk.app.mjs";

export default {
key: "freshdesk-close-ticket",
name: "Close Ticket",
description: "Set a Freshdesk ticket's status to 'Closed'. [See docs](https://developers.freshdesk.com/api/#update_a_ticket)",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
},
async run({ $ }) {
const CLOSED_STATUS = 5; // Freshdesk status code for 'Closed'

const response = await this.freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${this.ticketId}`,
data: {
status: CLOSED_STATUS,
},
});

$.export("$summary", `Ticket ${this.ticketId} closed successfully`);
return response;
},
};
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
key: "freshdesk-create-company",
name: "Create a Company",
description: "Create a company. [See the documentation](https://developers.freshdesk.com/api/#create_company)",
version: "0.0.3",
version: "0.0.4",
type: "action",
props: {
freshdesk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default {
key: "freshdesk-create-contact",
name: "Create a Contact",
description: "Create a contact. [See the documentation](https://developers.freshdesk.com/api/#create_contact)",
version: "0.0.3",
version: "0.0.4",
type: "action",
props: {
freshdesk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
key: "freshdesk-create-ticket",
name: "Create a Ticket",
description: "Create a ticket. [See the documentation](https://developers.freshdesk.com/api/#create_ticket)",
version: "0.0.4",
version: "0.0.5",
type: "action",
props: {
freshdesk,
Expand Down
2 changes: 1 addition & 1 deletion components/freshdesk/actions/get-ticket/get-ticket.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
key: "freshdesk-get-ticket",
name: "Get Ticket Details",
description: "Get details of a Ticket. [See the documentation](https://developers.freshdesk.com/api/#view_a_ticket)",
version: "0.1.1",
version: "0.1.2",
type: "action",
props: {
freshdesk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default {
name: "List Tickets",
description:
"Fetch up to 100 tickets according to the selected filters. [See the documentation](https://developers.freshdesk.com/api/#list_all_tickets)",
version: "0.2.1",
version: "0.2.2",
type: "action",
props: {
freshdesk,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import freshdesk from "../../freshdesk.app.mjs";

export default {
key: "freshdesk-set-ticket-priority",
name: "Set Ticket Priority",
description: "Update the priority of a ticket in Freshdesk [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
ticketPriority: {
propDefinition: [
freshdesk,
"ticketPriority",
],
},
},
async run({ $ }) {

const ticketName = await this.freshdesk.getTicketName(this.ticketId);

const response = await this.freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${this.ticketId}`,
data: {
priority: this.ticketPriority,
},
});

const priorityLabels = {
1: "Low",
2: "Medium",
3: "High",
4: "Urgent",
};

const priorityLabel = priorityLabels[this.ticketPriority] || this.ticketPriority;

$.export("$summary",
`Ticket ${ticketName} (ID: ${this.ticketId}) priority updated to "${priorityLabel}".`);

return response;
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import freshdesk from "../../freshdesk.app.mjs";

export default {
key: "freshdesk-set-ticket-status",
name: "Set Ticket Status",
description: "Update the status of a ticket in Freshdesk [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
ticketStatus: {
propDefinition: [
freshdesk,
"ticketStatus",
],
},
},
async run({ $ }) {

const ticketName = await this.freshdesk.getTicketName(this.ticketId);

const response = await this.freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${this.ticketId}`,
data: {
status: this.ticketStatus,
},
});

const statusLabels = {
2: "Open",
3: "Pending",
4: "Resolved",
5: "Closed",
};

const statusLabel = statusLabels[this.ticketStatus] || this.ticketStatus;

$.export(
"$summary",
`Ticket "${ticketName}" (ID: ${this.ticketId}) status updated to "${statusLabel}".`,
);

return response;
},
};
122 changes: 122 additions & 0 deletions components/freshdesk/actions/update-ticket/update-ticket.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
import freshdesk from "../../freshdesk.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";

export default {
key: "freshdesk-update-ticket",
name: "Update a Ticket",
description: "Update status, priority, subject, description, agent, group, etc. [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
version: "0.0.1",
type: "action",
props: {
freshdesk,
ticketId: {
propDefinition: [
freshdesk,
"ticketId",
],
},
status: {
propDefinition: [
freshdesk,
"ticketStatus",
],
optional: true,
},
priority: {
propDefinition: [
freshdesk,
"ticketPriority",
],
optional: true,
},
subject: {
type: "string",
label: "Subject",
description: "Ticket subject",
optional: true,
},
description: {
type: "string",
label: "Description",
description: "Detailed ticket description (HTML allowed)",
optional: true,
},
group_id: {
propDefinition: [
freshdesk,
"groupId",
],
},
responder_id: {
propDefinition: [
freshdesk,
"agentId",
],
},
email: {
type: "string",
label: "Requester Email (replaces requester)",
description: "Updates the requester. If no contact with this email exists, a new one will be created and assigned to the ticket.",
optional: true,
},
phone: {
type: "string",
label: "Requester Phone (replaces requester)",
description: "If no contact with this phone number exists, a new one will be created. If used without email, 'name' is required.",
optional: true,
},
name: {
type: "string",
label: "Requester Name (required with phone if no email)",
description: "Used when creating a contact with phone but no email.",
optional: true,
},
type: {
type: "string",
label: "Type",
description: "Type of ticket (must match one of the allowed values)",
optional: true,
options: [
"Question",
"Incident",
"Problem",
"Feature Request",
"Refund",
],
},
custom_fields: {
type: "object",
label: "Custom Fields",
description: "Custom fields as key-value pairs (make sure types match your config)",
optional: true,
},
},
async run({ $ }) {
const {
freshdesk,
ticketId,
...fields
} = this;

const data = removeNullEntries(fields);

const ticketName = await freshdesk.getTicketName(ticketId);

if (!Object.keys(data).length) {
throw new Error("Please provide at least one field to update.");
}

if (data.custom_fields) freshdesk.parseIfJSONString(data.custom_fields);

const response = await freshdesk._makeRequest({
$,
method: "PUT",
url: `/tickets/${ticketId}`,
data,
});

$.export("$summary", `Ticket "${ticketName}" (ID: ${this.ticketId}) updated successfully`);
return response;
},
};

Loading
Loading