TOPdesk ACTION
Update Incident
Updates an existing incident. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's TOPdesk account once, then configure and run Update Incident 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: "topdesk-update-incident",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
topdesk: { authProvisionId: "apn_xxxxxxx" },
incidentId: "Incident ID",
callerLookupId: "Caller Lookup ID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "topdesk-update-incident",
"configured_props": {
"topdesk": { "authProvisionId": "apn_xxxxxxx" },
"incidentId": "Incident ID",
"callerLookupId": "Caller Lookup ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "topdesk",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "topdesk-update-incident",
arguments: {
incidentId: "Incident ID",
callerLookupId: "Caller Lookup ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
incidentId Incident ID | string | The UUID of the incident Required Dynamic |
callerLookupId Caller Lookup ID | string | Lookup value for filling in a registered caller's contact details (UUID). Can only be set by operators. Optional Dynamic |
briefDescription Brief Description | string | Brief description of the incident (max 80 characters) Optional |
request Request | string | The initial request text. HTML tags are supported: <i>, <em>, <b>, <strong>, <u>, <br>, <h5>, <h6> Optional |
action Action | string | The action text to add. HTML tags are supported: <i>, <em>, <b>, <strong>, <u>, <br>, <h5>, <h6> Optional |
actionInvisibleForCaller Action Invisible For Caller | boolean | Whether the action is invisible for persons. Can only be set by operators. Optional |
categoryId Category ID | string | The UUID of the category Optional Dynamic |
subcategoryId Subcategory ID | string | The UUID of the subcategory Optional Dynamic |
callTypeId Call Type ID | string | The UUID of the call type Optional Dynamic |
callDate Call Date | string | The date when this call was registered in ISO 8601 format (e.g., 2024-08-01T12:00:00.000+0200). Can only be set by operators. Optional |
entryTypeId Entry Type ID | string | The UUID of the entry type Optional Dynamic |
externalNumber External Number | string | External number (max 60 characters). Can only be set by operators. Optional |
objectName Object Name | string | The UUID of the object (asset). Can only be set by operators. Optional Dynamic |
locationId Location ID | string | The UUID of the location Optional Dynamic |
branchId Branch ID | string | The UUID of the branch Optional Dynamic |
impact Impact ID | string | The UUID of the impact Optional Dynamic |
urgency Urgency ID | string | The UUID of the urgency Optional Dynamic |
priority Priority ID | string | The UUID of the priority Optional Dynamic |
duration Duration ID | string | The UUID of the duration Optional Dynamic |
targetDate Target Date | string | Target date in ISO 8601 format (e.g., 2024-08-01T12:00:00.000+0200). Can only be set by operators. Optional |
slaId SLA ID | string | The UUID of the SLA Optional Dynamic |
onHold On Hold | boolean | Whether the incident is on hold. Can only be set by operators. Optional |
operatorId Operator | string | The operator assigned to the incident. Can only be set by operators. Optional Dynamic |
operatorGroupId Operator Group ID | string | The UUID of the operator group Optional Dynamic |
supplierId Supplier ID | string | The UUID of the supplier Optional Dynamic |
processingStatusId Processing Status ID | string | The UUID of the processing status Optional Dynamic |
responded Responded | boolean | Whether the incident is responded. SLM-licence is needed. Can only be set by operators. Optional |
responseDate Response Date | string | Response date in ISO 8601 format. SLM-licence is needed. Can only be set by operators. Optional |
completed Completed | boolean | Whether the incident is completed. Can only be set by operators. Optional |
completedDate Completed Date | string | Completed date in ISO 8601 format. Can only be set by operators. Optional |
closed Closed | boolean | Whether the incident is closed. Can only be set by operators. Optional |
closedDate Closed Date | string | Closed date in ISO 8601 format. Can only be set by operators. Optional |
closureCodeId Closure Code ID | string | The UUID of the closure code Optional Dynamic |
costs Costs | string | Costs as a decimal number. Can only be set by operators. Optional |
feedbackMessage Feedback Message | string | Feedback message from the caller Optional |
feedbackRating Feedback Rating | integer | Feedback rating (1-5). Can be set by persons. Optional |
majorCall Major Call | boolean | Whether the incident is a major call. Can only be set by operators. Optional |
majorCallObject Major Call Object | object | Major call details as a JSON object. Can only be set by operators. Optional |
publishToSsd Publish To SSD | boolean | Whether to publish the incident to Self Service Desk. Can only be set by operators. Optional |
optionalFields1 Optional Fields 1 | object | Optional fields tab 1 as a JSON object Optional |
optionalFields2 Optional Fields 2 | object | Optional fields tab 2 as a JSON object 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
- topdesk-update-incident
- Version
- 0.0.3
- App
- TOPdesk
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Idempotent
- No
- Open world
- Yes
- Source
- View on GitHub ↗