CONNECT APP
Build with Freshservice
Help Desk & Support
- API key
MCP
Give your agent Freshservice tools
Every Freshservice action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Freshservice account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "freshservice",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Solution Article:
const result = await mcp.callTool({
name: "freshservice-create-solution-article",
arguments: {
title: "Title",
description: "Description",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "freshservice",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Solution Article:
result = await session.call_tool("freshservice-create-solution-article", {
"title": "Title",
"description": "Description",
})API PROXY
Call the Freshservice API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Freshservice API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed Freshservice endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Freshservice actions from your backend
Connect a user's Freshservice account once, then run Create Solution Article on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "freshservice-create-solution-article",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
freshservice: { authProvisionId: "apn_xxxxxxx" },
title: "Title",
description: "Description",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="freshservice-create-solution-article",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"freshservice": {"authProvisionId": "apn_xxxxxxx"},
"title": "Title",
"description": "Description",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "freshservice-create-solution-article",
"configured_props": {
"freshservice": { "authProvisionId": "apn_xxxxxxx" },
"title": "Title",
"description": "Description"
}
}'TOOLS
Freshservice actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Solution Article
actionCreate a solution article. See the documentationWritev0.0.2 -
Create Ticket
actionCreate a new ticket. See the documentationWritev0.0.2 -
Delete Solution Article
actionDelete a solution article. See the documentationWritev0.0.2 -
Get Solution Article
actionGet a solution article by ID. See the documentationRead-onlyv0.0.2 -
Get Ticket
actionGet a ticket by ID. See the documentationRead-onlyv0.0.2 -
List Solution Articles
actionList all solution articles. See the documentationRead-onlyv0.0.2 -
List Solution Categories
actionList all solution categories. See the documentationRead-onlyv0.0.2 -
List Solution Category ID Options
actionRetrieves available options for the Solution Category ID field.Read-onlyv0.0.1 -
List Ticket ID Options
actionRetrieves available options for the Ticket ID field.Read-onlyv0.0.1 -
Update Solution Article
actionUpdate a solution article. See the documentationWritev0.0.2 -
Update Ticket
actionUpdate a ticket. See the documentationWritev0.0.2
EVENTS
Freshservice triggers
Event sources your backend can deploy for users and receive through a webhook.
-
New Solution Article
triggerEmit new event for each created solution article. See documentationv0.0.1 -
New Ticket
triggerEmit new event for each created ticket. See documentationv0.0.3 -
Solution Article Updated
triggerEmit new event for each updated solution article. See documentationv0.0.1 -
Ticket Updated
triggerEmit new event for each updated ticket. See documentationv0.0.1
MULTI-APP
Use Freshservice with other popular apps
Most products don't stop at one integration. Pair Freshservice with the other apps your users rely on, and ship use cases that span both.
- App slug
- freshservice
- Authentication
- API key
- Categories
- Help Desk & Support
- Actions
- 11
- Triggers
- 4
- API proxy
- Available