View as Markdown
Zendesk icon

Zendesk ACTION

Search Help Center

Searches across knowledge base articles, community posts, and external records using the Zendesk unified Guide search. 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 Help Center 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-help-center",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    locales: ["Locales"],
    query: "Search Query",
  },
})

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 Help Center inputs
Property Type Description
locales Locales string[]
Required. One or more locales to search in (e.g. en-us, en-gb). If an invalid or disabled locale is specified, no results are returned.
Required Dynamic
query Search Query string
The search text to match. If omitted, results are returned using internal ordering.
Optional
contentTypes Content Types string[]
Limit results to one or more content types. Use ARTICLE or POST. To search external records, use the External Source IDs filter instead.
Optional
brandIds Brand IDs string[]
Limit results to articles or posts within these brands. If omitted, results are returned across all brands.
Optional Dynamic
categoryIds Category IDs string[]
Limit results to articles in these categories.
Optional Dynamic
sectionIds Section IDs string[]
Limit results to articles in these sections.
Optional Dynamic
topicIds Topic IDs string[]
Limit results to posts in these community topics.
Optional Dynamic
externalSourceIds External Source IDs string[]
Limit results to specific external sources. If omitted, results are returned across all sources.
Optional Dynamic
pageSize Page Size integer
Maximum number of results to return per page. Between 1 and 50. Default is 10.
Optional
pageAfter Page After Cursor string
Cursor string for the next page of results, obtained from a previous response.
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-help-center
Version
0.0.9
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes