View as Markdown
Zendesk icon

Zendesk ACTION

Update Side Conversation

Update the state or subject of a Zendesk side conversation. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zendesk account once, then configure and run Update Side Conversation 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-update-side-conversation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zendesk: { authProvisionId: "apn_xxxxxxx" },
    ticketId: "Ticket ID",
    sideConversationId: "Side Conversation 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.

Update Side Conversation inputs
Property Type Description
ticketId Ticket ID string
The ID of the ticket.
Required Dynamic
sideConversationId Side Conversation ID string
Identifier of the side conversation (UUID, e.g. 8566255a-ece5-11e8-857d-493066fa7b17). Select List Side Conversations to see available IDs for a ticket.
Required Dynamic
state State string
The new state of the side conversation. One of open or closed, e.g. closed to close the conversation.
Optional
subject Subject string
The subject of the side conversation message.
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-update-side-conversation
Version
0.0.2
App
Zendesk
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes