View as Markdown
Connecteam icon

Connecteam ACTION

Create Shift

Creates a new shift in the scheduler. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Connecteam account once, then configure and run Create 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: "connecteam-create-shift",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    connecteam: { authProvisionId: "apn_xxxxxxx" },
    schedulerId: "Scheduler ID",
    startTime: "Start Time",
  },
})

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 Shift inputs
Property Type Description
schedulerId Scheduler ID string
The ID of the scheduler.
Required Dynamic
startTime Start Time string
The start time of the shift in ISO8601 format (YYYY-MM-DDTHH:MM:SS.SSSZ).
Required
endTime End Time string
The end time of the shift in ISO8601 format (YYYY-MM-DDTHH:MM:SS.SSSZ).
Required
title Title string
The title of the shift.
Required
timezone Timezone string
The timezone of the shift in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings.
Optional
isPublished Is Published boolean
Whether the shift is published.
Optional
jobId Job ID string
The ID of the job.
Optional Dynamic
locationData Location Data object
The location data of the shift. Example {"gps":{"address": "Address Example 123","longitude":"-12.345678","latitude":"-12.345678"},"isReferencedToJob":false}. See the documentation.
Optional
assignedUserId Assigned User ID string
The ID of the assigned user.
Optional Dynamic
notes Notes string[]
Additional notes for the shift. HTML is supported. Example <p>Note example</p> See the documentation.
Optional
breaks Breaks string[]
A list of stringified objects of breaks to create for the shift. Example {"name":"Break name example","type":"paid","startTime":123456789,"duration":123} See the documentation.
Optional
isOpenShift Is Open Shift boolean
Whether the shift is an open shift.
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
connecteam-create-shift
Version
0.0.2
App
Connecteam
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes