View as Markdown
Zendesk icon

Zendesk ACTION

Search Articles

Searches Help Center articles. 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 Articles 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-articles",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    locale: "Locale",
  },
})

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 Articles inputs
Property Type Description
query Search Query string
The search text to match (e.g. carrot potato). At least one of this, Category, Section, or Label Names must be provided.
Optional
locale Locale string
Search for articles in the specified locale (e.g. en-us). Use * to search across all valid locales. Defaults to the Help Center's default locale if omitted or invalid.
Optional Dynamic
articleCategoryId Category string[]
Limit results to articles in these categories. Accepts one or more category IDs.
Optional Dynamic
sectionId Section string[]
Limit results to articles in these sections. Accepts one or more section IDs.
Optional Dynamic
labelNames Label Names string[]
Filter articles by label names. An article must have at least one of the labels to match. Matching is case-insensitive. Only available on Professional and Enterprise plans.
Optional Dynamic
brandId Brand ID string
Limit results to articles in the specified brand. If Multibrand is also set, results are still scoped to this brand.
Optional Dynamic
multibrand Multibrand boolean
If true, search returns results from all brands. If Brand ID is also set, results are scoped to that brand regardless of this setting.
Optional
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 articles created before this date (format YYYY-MM-DD).
Optional
createdAfter Created After string
Limit results to articles created after this date (format YYYY-MM-DD).
Optional
createdAt Created At string
Limit results to articles created on this date (format YYYY-MM-DD).
Optional
updatedBefore Updated Before string
Limit results to articles updated before this date (format YYYY-MM-DD). Note: only content-meaningful updates are re-indexed.
Optional
updatedAfter Updated After string
Limit results to articles updated after this date (format YYYY-MM-DD). Note: only content-meaningful updates are re-indexed.
Optional
updatedAt Updated At string
Limit results to articles 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. 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-articles
Version
0.0.9
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes