View as Markdown
Zendesk icon

Zendesk ACTION

Search Tickets

Searches for tickets using Zendesk's search API. 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 Tickets 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-tickets",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    sortBy: "Sort By",
  },
})

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 Tickets inputs
Property Type Description
query Search Query string
The search query to find tickets. You can use Zendesk's search syntax. Example: type:ticket status:open priority:high. See the documentation
Required
sortBy Sort By string
Field to sort tickets by
Optional
sortOrder Sort Order string
Sort order (ascending or descending)
Optional
limit Limit integer
Maximum number of tickets to return
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
page Page integer
The page number to retrieve. Default is 1.
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-tickets
Version
0.0.20
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes