CONNECT APP
Build with Freshchat
Customer Messaging, Live Chat & Chatbots
Help Desk & Support
- API key
MCP
Give your agent Freshchat tools
Every Freshchat 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 Freshchat 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": "freshchat",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Fetch Conversation Details:
const result = await mcp.callTool({
name: "freshchat-fetch-conversation-details",
arguments: {
userId: "User ID",
conversationId: "Conversation ID",
},
})# 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": "freshchat",
}
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 Fetch Conversation Details:
result = await session.call_tool("freshchat-fetch-conversation-details", {
"userId": "User ID",
"conversationId": "Conversation ID",
})SDK
Run Freshchat actions from your backend
Connect a user's Freshchat account once, then run Fetch Conversation Details 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: "freshchat-fetch-conversation-details",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
freshchat: { authProvisionId: "apn_xxxxxxx" },
userId: "User ID",
conversationId: "Conversation ID",
},
})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="freshchat-fetch-conversation-details",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"freshchat": {"authProvisionId": "apn_xxxxxxx"},
"userId": "User ID",
"conversationId": "Conversation ID",
},
)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": "freshchat-fetch-conversation-details",
"configured_props": {
"freshchat": { "authProvisionId": "apn_xxxxxxx" },
"userId": "User ID",
"conversationId": "Conversation ID"
}
}'TOOLS
Freshchat actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Fetch Conversation Details
actionFetches details for a specific conversation. See the documentationRead-onlyv0.0.4 -
List Agent ID Options
actionRetrieves available options for the Agent ID field.Read-onlyv0.0.1 -
List Agents
actionLists all agents in Freshchat. See the documentationRead-onlyv0.0.4 -
List All Conversation Properties
actionRetrieves a list of all conversation properties configured in the Freshchat system. See the documentationRead-onlyv0.0.2 -
List Channels
actionLists all channels in Freshchat. See the documentationRead-onlyv0.0.4 -
List Group ID Options
actionRetrieves available options for the Group ID field.Read-onlyv0.0.1 -
List Messages
actionLists all messages in a conversation. See the documentationRead-onlyv0.0.4 -
List User ID Options
actionRetrieves available options for the User ID field.Read-onlyv0.0.1 -
Send Message in Chat
actionSends a message in a specific conversation. See the documentationWritev0.0.5 -
Update Conversation
actionUpdates a conversation's status, assignment, or properties. See the documentationWritev0.0.5
EVENTS
Freshchat triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use Freshchat with other popular apps
Most products don't stop at one integration. Pair Freshchat with the other apps your users rely on, and ship use cases that span both.
- App slug
- freshchat
- Authentication
- API key
- Categories
- Help Desk & Support
- Actions
- 10
- Triggers
- 2
- API proxy
- Not available