Skip to docs navigation

Breathe HR integration guide

Verified

How to connect Breathe HR to WEXTL and use its 8 triggers and 40 actions in your workflows. About Breathe HR: Cloud HR software for employee records, leave, onboarding, and people management.

  • 8 triggers
  • 23 searches
  • 17 actions
  • Polling
  • Auth: API key

AI-assisted documentation19 min read

This documentation is compiled from our integration source code, internal specs for Breathe HR, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Breathe HR on WEXTL →
  • Breathe HR
  • WEXTL
  • BrioHR
  • ClickTime
  • ClockIt
  • Assembled
  • Calamari
  • Charlie HR
  • BuddyPunch
  • Base.vn
  • Dayforce
  • Darwinbox
  • Combo HR
  • Clockify
  • actiTIME
  • Connecteam
  • BambooHR
  • Ashby
  • Affinda
  • Cezanne HR
  • Ease
  • EBP Paie
  • Achievers
  • BrightHR
  • 7Shifts
  • Bullhorn
  • Aladtec
  • Beamery
  • Ceipal
  • DailyPay
  • Breezy HR
  • EnvironmentselectRequired
  • API KeypasswordRequired

    Log in to your account, go to Configure → Settings → API Setup, and generate your API key from there.[1]

  1. Log in to your WEXTL account, add the Breathe HR node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Breathe HR account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Breathe HR to WEXTL®
Video slide demonstrates how to integrate Breathe HR in the WEXTL visual workflow builder.[4]

Watch Absence

Trigger
Output fields[3]
FieldType
Employeeobject
IDtext
Emailtext
First nametext
Last nametext
Approved bytext
Leave reasontext
Deductedtext
Work unitstext
IDnumber
Start datetext
Half startboolean
Half start am pmtext
End datetext
Half endboolean
Half end am pmtext
Cancelledboolean
Notestext
Typetext
Created atdate
Updated atdate

Watch Benefits

Trigger
Output fields[3]
FieldType
IDtext
Start datetext
End datetext
Review datetext
Amounttext
Providertext
Pension opt outtext
Employer contributiontext
Employee contributiontext
Created atdate
Updated atdate

Watch Bonuses

Trigger
Output fields[3]
FieldType
IDtext
Descriptiontext
Amounttext
Award datetext
Created atdate
Updated atdate

Watch Change Requests

Trigger
Output fields[3]
FieldType
IDtext
Field nametext
Valuetext
Approvedtext
Approved attext
Created atdate
Updated atdate

Watch Departments

Trigger
Output fields[3]
FieldType
IDtext
Nametext
Created atdate
Updated atdate

Watch Employee Jobs

Trigger
Output fields[3]
FieldType
Titletext
Fulltime parttimetext
Start datetext
End datetext
Contract end datetext
Created atdate
Updated atdate

Watch Employees

Trigger
Output fields[3]
FieldType
Length of service in monthstext
Agetext
Full or part timetext
Notice periodtext
Photo URLtext
Working patterntext
Total working hourstext
Holiday allowancetext
Line managertext
Is line managertext
Holiday approvertext
Departmenttext
Divisiontext
Locationtext
Gendertext
Statutory holiday countrytext
Receives statutory holidaystext
Salarytext
Statustext
Job start datetext

51other output fields

Watch Leave Requests

Trigger
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Get a Cancelling Leave Request

Action
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Get a Leave Request

Action
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Get Absences

Search
Input fields[3]
FieldType
Typechoice
Other Leave Reason IDnumber
Exclude Cancelled Absencesboolean
Employee IDchoice
Department IDchoice
Start Datedate
End Datedate
Rotacloudboolean
Limitnumber
Output fields[3]
FieldType
Employeeobject
IDtext
Emailtext
First nametext
Last nametext
Approved bytext
Leave reasontext
Deductedtext
Work unitstext
IDnumber
Start datetext
Half startboolean
Half start am pmtext
End datetext
Half endboolean
Half end am pmtext
Cancelledboolean
Notestext
Typetext
Created atdate
Updated atdate

Get Absences for a Department

Search
Input fields[3]
FieldType
Department IDRequired
choice
Exclude Cancelled Absencesboolean
Limitnumber
Output fields[3]
FieldType
Employeeobject
IDtext
Emailtext
First nametext
Last nametext
Approved bytext
Leave reasontext
Deductedtext
Work unitstext
IDnumber
Start datetext
Half startboolean
Half start am pmtext
End datetext
Half endboolean
Half end am pmtext
Cancelledboolean
Notestext
Typetext
Created atdate
Updated atdate

Get an Employee

Action
Input fields[3]
FieldType
Employee IDRequired
choice
Output fields[3]
FieldType
Length of service in monthstext
Agetext
Full or part timetext
Notice periodtext
Photo URLtext
Working patterntext
Total working hourstext
Holiday allowancetext
Line managertext
Is line managertext
Holiday approvertext
Departmenttext
Divisiontext
Locationtext
Gendertext
Statutory holiday countrytext
Receives statutory holidaystext
Salarytext
Statustext
Job start datetext

51other output fields

Get an Employee Expense

Action
Input fields[3]
FieldType
Employee Expense Record IDRequired
choice
Output fields[3]
FieldType
IDtext
Employee IDtext
Account IDtext
Employee expense claim IDtext
Expense datetext
Descriptiontext
Company expense type IDtext
Company project IDtext
Company mileage rate IDtext
Amounttext
Milestext
Payable to employeetext
Chargeable to clienttext
Client nametext
Vattext

Get an Expense Claim

Action
Input fields[3]
FieldType
Expense Claim IDRequired
choice
Output fields[3]
FieldType
Employeetext
Employee expensestext
IDtext
Account IDtext
Employee IDtext
Remuneration currency IDtext
Submitted datetext
Approver IDtext
Approved datetext
Rejected by IDtext
Rejected datetext
Paid by IDtext
Paid datetext
Closedby IDtext
Closed datetext
Descriptiontext
Old claim statustext
Statetext
Reject reasontext
Paidtext

1other output field

Get Benefits

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Start datetext
End datetext
Review datetext
Amounttext
Providertext
Pension opt outtext
Employer contributiontext
Employee contributiontext
Created atdate
Updated atdate

Get Benefits for a Department

Search
Input fields[3]
FieldType
Department IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Start datetext
End datetext
Review datetext
Amounttext
Providertext
Pension opt outtext
Employer contributiontext
Employee contributiontext
Created atdate
Updated atdate

Get Bonuses

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Descriptiontext
Amounttext
Award datetext
Created atdate
Updated atdate

Get Bonuses for a Department

Search
Input fields[3]
FieldType
Department IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Descriptiontext
Amounttext
Award datetext
Created atdate
Updated atdate

Get Change Requests

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Field nametext
Valuetext
Approvedtext
Approved atdate
Created atdate
Updated atdate

Get Departments

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Created atdate
Updated atdate

Get Employee Expense Claims

Search
Input fields[3]
FieldType
Employee IDRequired
choice
State Filterchoice
Limitnumber
Output fields[3]
FieldType
Employeetext
Employee expensestext
IDtext
Account IDtext
Employee IDtext
Remuneration currency IDtext
Submitted datetext
Approver IDtext
Approved datetext
Rejected by IDtext
Rejected datetext
Paid by IDtext
Paid datetext
Closedby IDtext
Closed datetext
Descriptiontext
Old claim statustext
Statetext
Reject reasontext
Paidtext

1other output field

Get Employee Expenses

Search
Input fields[3]
FieldType
Employee IDchoice
Show Claimedboolean
Limitnumber
Output fields[3]
FieldType
IDtext
Employee IDtext
Account IDtext
Employee expense claim IDtext
Expense datetext
Descriptiontext
Company expense type IDtext
Company project IDtext
Company mileage rate IDtext
Amounttext
Milestext
Payable to employeetext
Chargeable to clienttext
Client nametext
Vattext

Get Employee Jobs

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Titletext
Fulltime parttimetext
Start datetext
End datetext
Contract end datetext
Created atdate
Updated atdate

Get Employee Training Courses

Search
Input fields[3]
FieldType
Employee IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Start ontext
End ontext
Half daytext
Half day am pmtext
Expires ontext
Hourstext
Costtext
Statustext
Outcometext
Remuneration currency IDtext
Rejection reasontext
Notestext
Followup datetext
Employeetext
Company training typetext
Company training categorytext
Company training providertext

Get Employees

Search
Input fields[3]
FieldType
Filterchoice
Rotacloudboolean
Limitnumber
Output fields[3]
FieldType
Length of service in monthstext
Agetext
Full or part timetext
Notice periodtext
Photo URLtext
Working patterntext
Total working hourstext
Holiday allowancetext
Line managertext
Is line managertext
Holiday approvertext
Departmenttext
Divisiontext
Locationtext
Gendertext
Statutory holiday countrytext
Receives statutory holidaystext
Salarytext
Statustext
Job start datetext

51other output fields

Get Leave Requests

Search
Input fields[3]
FieldType
Start Datedate
End Datedate
Exclude Cancelled Requestsboolean
Employee IDchoice
Department IDchoice
Rotacloudboolean
Limitnumber
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Get Leave Requests

Search
Input fields[3]
FieldType
Department IDRequired
choice
Exclude Cancelled Absencesboolean
Limitnumber
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Get Other Leave Reasons

Search
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext

Get Salaries for a Department

Search
Input fields[3]
FieldType
Department IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Start datetext
End datetext
Amounttext
Basistext
Created atdate
Updated atdate

Get Sicknesses

Search
Input fields[3]
FieldType
Start Datedate
End Datedate
Employee IDchoice
Department IDchoice
Rotacloudboolean
Limitnumber
Output fields[3]
FieldType
Company sicknesstypetext
Employeetext
IDtext
Start datetext
End datetext
Half starttext
Half start am pmtext
Half endtext
Half end am pmtext
Deductedtext
Statustext
Review notestext
Fit note requiredtext
Reasontext

Approve a Leave Request

Action
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Approve an Employee Change Request

Action
Input fields[3]
FieldType
Employee IDRequired
choice
Change Request IDRequired
choice
Output fields[3]
FieldType
IDtext
Field nametext
Valuetext
Approvedtext
Approved attext
Created atdate
Updated atdate

Approve or Reject an Expense Claim

Action
Input fields[3]
FieldType
Approve Expense ClaimRequired
boolean
Approver/Rejector IDRequired
number
Rejection Reasontext
Output fields[3]
FieldType
Employeetext
Employee expensestext
IDtext
Account IDtext
Employee IDtext
Remuneration currency IDtext
Submitted datetext
Approver IDtext
Approved datetext
Rejected by IDtext
Rejected datetext
Paid by IDtext
Paid datetext
Closedby IDtext
Closed datetext
Descriptiontext
Old claim statustext
Statetext
Reject reasontext
Paidtext

1other output field

Cancel an Absence

Action
Input fields[3]
FieldType
ID of Absence to CancelRequired
choice
Reason for Cancellationtext
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Create an Employee

Action
Input fields[3]
FieldType
First NameRequired
text
Last NameRequired
text
EmailRequired
email
Company Join DateRequired
date
Middle Nametext
Gendertext
Date of Birthdate
Marital Statustext
Nationalitytext
National Insurance Numbertext
Ethnicitytext
Ethnicity IDtext
DDItext
Work Extensiontext
Work Mobiletext
Personal Mobiletext
Home Telephonetext
Statustext
Job Titletext
Full or Part Timetext

16other input fields

Output fields[3]
FieldType
Length of service in monthstext
Agetext
Full or part timetext
Notice periodtext
Photo URLtext
Working patterntext
Total working hourstext
Holiday allowancetext
Line managertext
Is line managertext
Holiday approvertext
Departmenttext
Divisiontext
Locationtext
Gendertext
Statutory holiday countrytext
Receives statutory holidaystext
Salarytext
Statustext
Job start datetext

51other output fields

Create an Employee Expense

Action
Input fields[3]
FieldType
Employee IDRequired
choice
Expense DateRequired
date
DescriptionRequired
text
Company Expense Type IDRequired
number
AmountRequired
number
Payable to EmployeeRequired
boolean
VATnumber
Company Project IDnumber
Company Mileage Rate IDnumber
Milesnumber
Chargeable to Clientboolean
Client Nametext
Has Receiptboolean
Output fields[3]
FieldType
IDtext
Employee IDnumber
Account IDnumber
Employee expense claim IDtext
Expense datetext
Descriptiontext
Company expense type IDnumber
Company project IDtext
Company mileage rate IDtext
Amounttext
Milestext
Payable to employeeboolean
Chargeable to clienttext
Client nametext
Vattext

Create an Expense Claim

Action
Input fields[3]
FieldType
Employee IDRequired
choice
Employee Expense IDschoice
Output fields[3]
FieldType
Employeetext
Employee expensestext
IDtext
Account IDtext
Employee IDtext
Remuneration currency IDtext
Submitted datetext
Approver IDtext
Approved datetext
Rejected by IDtext
Rejected datetext
Paid by IDtext
Paid datetext
Closedby IDtext
Closed datetext
Descriptiontext
Old claim statustext
Statetext
Reject reasontext
Paidtext

1other output field

Create Employee Training

Action
Input fields[3]
FieldType
Employee IDRequired
choice
NameRequired
text
Company Training Type IDRequired
number
Statustext
Remuneration Currency IDnumber
Company Training Category IDnumber
Company Training Provider IDnumber
Start Ondate
Half Day AM/PMchoice
End Ondate
Followup Datedate
Costnumber
Outcometext
Notestext
Output fields[3]
FieldType
IDtext
Nametext
Start ontext
End ontext
Half daytext
Half day am pmtext
Expires ontext
Hourstext
Costtext
Statustext
Outcometext
Remuneration currency IDtext
Rejection reasontext
Notestext
Followup datetext
Employeetext
Company training typetext
Company training categorytext
Company training providertext

Delete a Sickness

Action
Input fields[3]
FieldType
Sickness IDRequired
choice

Delete an Employee Expense

Action
Input fields[3]
FieldType
Employee Expense Record IDRequired
choice

Delete an Expense Claim

Action
Input fields[3]
FieldType
Expense Claim IDRequired
choice

Delete Employee Training

Action
Input fields[3]
FieldType
IDchoice

Make an API Call

universal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Reject a Leave Request

Action
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
IDtext
Start datetext
Half starttext
Half start am pmtext
End datetext
Half endtext
Half end am pmtext
Actiontext
Statustext
Notestext
Created atdate
Updated atdate

Update a Sickness

Action
Input fields[3]
FieldType
Sickness IDRequired
choice
Company Sickness Typetext
Employeetext
Start Datedate
End Datedate
Half Startboolean
Half Start AM/PMchoice
Half Endboolean
Half End AM/PMchoice
Deductedboolean
Statustext
Review Notestext
Fit Note Requiredboolean
Reasontext
Output fields[3]
FieldType
Company sicknesstypetext
Employeetext
IDtext
Start datetext
End datetext
Half starttext
Half start am pmtext
Half endtext
Half end am pmtext
Deductedtext
Statustext
Review notestext
Fit note requiredtext
Reasontext

Update an Employee Expense

Action
Input fields[3]
FieldType
Employee Expense Record IDRequired
choice
Employee IDchoice
Account IDtext
Employee Expense Claim IDchoice
Expense Datedate
Descriptiontext
Company Expense Type IDtext
Company Project IDtext
Company Mileage Rate IDtext
Amountnumber
Milesnumber
Payable to Employeeboolean
Chargeable to Clientboolean
Client Nametext
VATnumber
Output fields[3]
FieldType
IDtext
Employee IDchoice
Account IDtext
Employee expense claim IDchoice
Expense datetext
Descriptiontext
Company expense type IDtext
Company project IDtext
Company mileage rate IDtext
Amounttext
Milestext
Payable to employeetext
Chargeable to clienttext
Client nametext
Vattext

Update Employee Training

Action
Input fields[3]
FieldType
IDRequired
choice
Nametext
Company Training Type IDnumber
Statustext
Remuneration Currency IDnumber
Company Training Category IDnumber
Company Training Provider IDnumber
Start Ondate
Half Daydate
Half Day AM/PMchoice
End Ondate
Followup Datedate
Costnumber
Outcometext
Notestext
Output fields[3]
FieldType
IDtext
Nametext
Start ontext
End ontext
Half daytext
Half day am pmtext
Expires ontext
Hourstext
Costtext
Statustext
Outcometext
Remuneration currency IDtext
Rejection reasontext
Notestext
Followup datetext
Employeetext
Company training typetext
Company training categorytext
Company training providertext

Look for Breathe HR templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Breathe HR Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Breathe HR.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.