View as Markdown
HelpSpot icon

HelpSpot ACTION

Get Request

Retrieves a single support request by ID. 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 Get Request 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-get-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    helpspot: { authProvisionId: "apn_xxxxxxx" },
    xRequest: "Request ID",
    fRawValues: true,
  },
})

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.

Get Request inputs
Property Type Description
xRequest Request ID string
The ID of the request, e.g., 12345.
Required Dynamic
fRawValues Raw Values boolean
Set to true to return numeric values instead of their text representations (e.g. status IDs instead of status names).
Optional
fIncludeTimeTotal Include Time Total boolean
Set to true to include total tracked time as iTimeTotal (seconds) and sTimeTotal (formatted string) in the response.
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-get-request
Version
0.0.2
App
HelpSpot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes