View as Markdown
Deputy icon

Deputy ACTION

Start Shift

Starts a work shift for a specified employee in Deputy. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Deputy account once, then configure and run Start Shift 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: "deputy-start-shift",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deputy: { authProvisionId: "apn_xxxxxxx" },
    locationId: "Location ID",
    employeeId: "Employee 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.

Start Shift inputs
Property Type Description
locationId Location ID string
The identifier of a location
Required Dynamic
employeeId Employee ID string
The identifier of an employee
Required 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
deputy-start-shift
Version
0.0.2
App
Deputy
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes