View as Markdown
Freshchat icon

Freshchat ACTION

List Messages

Lists all messages in a conversation. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Freshchat account once, then configure and run List Messages from your backend or agent.

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-list-messages",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    freshchat: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    conversationId: "Conversation ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Messages inputs
Property Type Description
userId User ID string
The ID of a user
Required Dynamic
conversationId Conversation ID string
The ID of a conversation
Required Dynamic
fromTime From Time string
UTC datetime to retrieve messages after this timestamp (ISO 8601 format). Example: 2025-01-01T00:00:00Z.
Optional
maxResults Max Results integer
The maximum number of results to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
freshchat-list-messages
Version
0.0.4
App
Freshchat
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes