View as Markdown
Breathe icon

Breathe ACTION

Create Employee

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

IMPLEMENTATION

Call this tool

Connect a user's Breathe account once, then configure and run Create Employee 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: "breathe-create-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    breathe: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

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 Employee inputs
Property Type Description
firstName First Name string
First name of the employee
Required
lastName Last Name string
Last name of the employee
Required
email Email string
Email address of the employee
Required
companyJoinDate Company Join Date string
The date that the employee joined the company. Example: 2023-12-25
Required
dob Date of Birth string
The date of birth of the employee
Optional
jobTitle Job Title string
The job title of the employee
Optional
departmentId Department ID string
The identifier of a department
Optional Dynamic
divisionId Division ID string
The identifier of a division
Optional Dynamic
locationId Location ID string
The identifier of a location
Optional Dynamic
workingPatternId Working Pattern ID string
The identifier of a working pattern
Optional Dynamic
holidayAllowanceId Holiday Allowance ID string
The identifier of a holiday allowance
Optional Dynamic
workMobile Work Mobile string
The work moblie phone number of the employee
Optional
personalMobile Personal Mobile string
The personal mobile phone number of the employee
Optional
homeTelephone Home Telephone string
The home telephone number of the employee
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
breathe-create-employee
Version
0.0.2
App
Breathe
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes