Freshdesk

Create and manage support tickets and add notes in Freshdesk.

Customer supportAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
get_all_tickets_by_status
get_contact_from_id
get_contacts
get_ticket_status
get_tickets
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("freshdesk", "get_all_tickets_by_status", {
    "status_filter": []
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Freshdesk answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "freshdesk-get-all-tickets-by-status",
  name: "Freshdesk: Get All Tickets By Status",
  description: "Calls Freshdesk when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("freshdesk", {
      "action": "get_all_tickets_by_status",
      "status_filter": []
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/freshdesk/get_all_tickets_by_status" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"status_filter":[]}}'

Actions

get_all_tickets_by_statusin catalog

Get All Tickets By Status. Get All Tickets by selected status from Freshdesk.

Input	Type	Description
`status_filter`required	list of	Select one or status values

get_contact_from_idin catalog

Get Contact from ID. Get contacts details from Freshdesk using ID number.

Input	Type	Description
`contactid`required	text	The ID number of the contact

get_contactsin catalog

Get Freshdesk Contacts. Get contact details from Freshdesk for all (optional filtered) contacts.

Input	Type	Description
`filter_type`optional	one of "email" \| "mobile" \| "phone" \| "company_id" \| "updated_since"	Select one and provide the value.
`filter_value`optional	text	Provide value if previous option selected!
`filter_status`optional	one of "blocked" \| "deleted" \| "unverified" \| "verified"	Can filter by state: blocked, deleted, unverified or verified.
`per_page`required	number	Freshdesk calls this per_page - set to 0 for all, if specified maximum is 100

get_ticket_statusin catalog

Get Ticket Status. Get Ticket status from Freshdesk. Returns ticket_status, assigned_status, assigned_id

Input	Type	Description
`ticketid`required	text	The Ticket ID to return status

get_ticketsin catalog

Get Tickets. Get Ticket instances from Freshdesk.

No input.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: freshdesk
Category: Customer support
Tags: helpdesk, tickets, support, freshworks
Package: @activepieces/piece-freshdesk@0.2.4
Tier: Built in