HelpSpot ACTION
Search Requests
Searches for support requests using one or more filter criteria. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's HelpSpot account once, then configure and run Search Requests 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: "helpspot-search-requests",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
helpspot: { authProvisionId: "apn_xxxxxxx" },
sSearch: "Search Text",
anyall: "Match Mode",
},
})
console.log(result)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": "helpspot-search-requests",
"configured_props": {
"helpspot": { "authProvisionId": "apn_xxxxxxx" },
"sSearch": "Search Text",
"anyall": "Match Mode"
}
}'// 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": "helpspot",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "helpspot-search-requests",
arguments: {
sSearch: "Search Text",
anyall: "Match Mode",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
sSearch Search Text | string | Full-text search string to match against request content. Optional |
anyall Match Mode | string | Whether all filters must match (default) or any single filter is sufficient. Optional |
xRequest Request ID | string | The ID of the request, e.g., 12345. Optional Dynamic |
xCategory Category | string | The category id of the request. Optional Dynamic |
xStatus Status | string | Select a status of the request Optional Dynamic |
fOpen Open/Closed | integer | Filter by whether the request is open or closed. Optional |
xPersonAssignedTo Assigned To | string | The ID of the staff member the request is assigned to. Use the List Active Staff action to retrieve valid staff IDs. Optional |
sUserId User ID | string | Filter by customer user ID, e.g., user_12345. Optional |
sFirstName First Name | string | Filter by customer first name. Optional |
sLastName Last Name | string | Filter by customer last name. Optional |
sEmail Email | string | Filter by customer email address. Optional |
sPhone Phone | string | Filter by customer phone number. Optional |
afterDate Opened After Date | string | Return requests opened after this date. Provide a Unix timestamp or a valid date string (e.g. 2024-01-01). Optional |
beforeDate Opened Before Date | string | Return requests opened before this date. Provide a Unix timestamp or a valid date string (e.g. 2024-12-31). Optional |
closedAfterDate Closed After Date | string | Return requests closed after this date. Provide a Unix timestamp or a valid date string (e.g. 2024-01-01). Optional |
closedBeforeDate Closed Before Date | string | Return requests closed before this date. Provide a Unix timestamp or a valid date string (e.g. 2024-12-31). Optional |
orderBy Order By | string | Field name to sort results by (e.g. xRequest, sLastName, dtGMTOpened). Optional |
orderByDir Order Direction | string | Sort direction for the Order By field. Optional |
length Max Results | integer | Maximum number of requests to return. Optional |
fRawValues Raw Values | boolean | Set to true to return numeric IDs instead of their text representations. Optional |
fIncludeTimeTotal Include Time Total | boolean | Set to true to include total tracked time as iTimeTotal (seconds) and sTimeTotal (formatted string) in each result. 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
- helpspot-search-requests
- Version
- 0.0.2
- App
- HelpSpot
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗