View as Markdown
Zendesk icon

Zendesk ACTION

Search Community Posts

Searches Help Center community posts. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zendesk account once, then configure and run Search Community Posts 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: "zendesk-search-community-posts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    topicId: "Topic 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.

Search Community Posts inputs
Property Type Description
query Search Query string
The search text to match (e.g. carrot potato).
Required
topicId Topic ID string
Limit results to posts in the specified community topic.
Optional Dynamic
sortBy Sort By string
Sort results by created_at or updated_at. Defaults to sorting by relevance.
Optional
sortOrder Sort Order string
Sort direction. Defaults to desc.
Optional
createdBefore Created Before string
Limit results to posts created before this date (format YYYY-MM-DD).
Optional
createdAfter Created After string
Limit results to posts created after this date (format YYYY-MM-DD).
Optional
createdAt Created At string
Limit results to posts created on this date (format YYYY-MM-DD).
Optional
updatedBefore Updated Before string
Limit results to posts updated before this date (format YYYY-MM-DD).
Optional
updatedAfter Updated After string
Limit results to posts updated after this date (format YYYY-MM-DD).
Optional
updatedAt Updated At string
Limit results to posts updated on this date (format YYYY-MM-DD).
Optional
limit Per Page integer
Number of results per page. Between 1 and 100. Default is 25.
Optional
page Page integer
Page number to retrieve. Must be greater than 0. Offset pagination is limited to the first 100 pages (10,000 records) — requests beyond this will return a 400 error. Default is 1.
Optional
customSubdomain Custom Subdomain string
For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is examplehelp
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
zendesk-search-community-posts
Version
0.0.9
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes