View as Markdown
UpKeep icon

UpKeep ACTION

Create Work Order

Create a Work Order, See the docs
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's UpKeep account once, then configure and run Create Work Order 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: "upkeep-create-work-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upkeep: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    description: "Description",
  },
})

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.

Create Work Order inputs
Property Type Description
title Title string
Title of the work order
Required
description Description string
Optional
priority Priority string
Priority of the request.
Optional
category Category string
One of the set categories for Work Orders on your account, including the default ones
Optional
dueDate Due Date string
Due date, in ISO 8601 format, e.g. 2022-09-07 or 2022-09-07T13:26:53
Optional
assetId Asset string
Asset Id
Optional Dynamic
locationId Location string
Location Id
Optional Dynamic
userId User string
User Id
Optional Dynamic
parts Parts string[]
An array of Part IDs to include with the work order
Optional Dynamic
respectivePartQuantityUsed Respective Part Quantities integer[]
The respective quantities of each part included in the parts array
Optional
decreaseInventory Decrease Inventory string
Can be auto or manual. Default is auto. If set to auto, inventory will be automatically be decreased when a part is added to a work order. If set to manual, inventory will NOT be decreased when a part is added to a work order.
Optional
time Time integer
The total time spent on the work order
Optional
cost Cost integer
The additional cost assigned to the work order
Optional
additionalUsers User string[]
An array of user IDs for additional workers assigned to the work order.
Optional Dynamic

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
upkeep-create-work-order
Version
0.0.3
App
UpKeep
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes