View as Markdown
Zendesk icon

Zendesk ACTION

List Macros

Retrieves all macros. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zendesk account once, then configure and run List Macros 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-list-macros",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    access: "Access",
    active: 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.

List Macros inputs
Property Type Description
access Access string
The access level of the macros to return
Optional
active Active boolean
Filter by active macros if true or inactive macros if false
Optional
macroCategory Macro Category string
The category of the macro
Optional Dynamic
groupId Group ID string
The ID of the group
Optional Dynamic
sortBy Sort By string
The field to sort the results by
Optional
sortOrder Sort Order string
Sort order (ascending or descending)
Optional
limit Limit integer
Maximum number of macros to return
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-list-macros
Version
0.0.15
App
Zendesk
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes