Skip to docs navigation

WebHR integration guide

Verified

How to connect WebHR to WEXTL and use its 32 triggers and 107 actions in your workflows. About WebHR: WebHR is a cloud HR platform for managing employees, attendance, leave, recruiting and projects.

  • 32 triggers
  • 86 searches
  • 21 actions
  • Polling
  • Auth: OAuth

AI-assisted documentation39 min read

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

Open WebHR on WEXTL →
  • WebHR
  • WEXTL
  • e-days
  • Ceipal
  • Breezy HR
  • DailyPay
  • Bullhorn
  • Cezanne HR
  • Achievers
  • Beamery
  • Aladtec
  • BrightHR
  • 7Shifts
  • Clockify
  • ClockIt
  • Calamari
  • ClickTime
  • Breathe HR
  • BrioHR
  • Darwinbox
  • BuddyPunch
  • Charlie HR
  • Dayforce
  • Combo HR
  • Assembled
  • Base.vn
  • BambooHR
  • CATS
  • actiTIME
  • Ashby
  • Connecteam
  • Affinda

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • Client IDtextRequired

    Contact support@webhr.co to obtain your credentials[1]

  • Client SecretpasswordRequired

    Contact support@webhr.co to obtain your credentials[1]

  1. Log in to your WEXTL account, add the WebHR 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 WebHR 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 →

Watch Achievements

TriggerAchievement records polled from WebHR.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
Empoyeetext
Achievement titletext
Achievement datedate

Watch Budgets

TriggerFreshly added budgets, caught on a schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Planning titletext
Budget titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext
Added ondate

Watch Candidate Forms

TriggerCandidate forms found by a scheduled check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Form typetext
Added ondate

Watch Candidates

TriggerCandidates that appeared after the previous poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
First nametext
Last namenumber
Date of birthtext
Gendernumber
Nationalitynumber
Addressnumber
Citytext
Email addressemail
Phone numbertext
Mobile numbertext

Watch Completed Courses

TriggerCompleted courses read from WebHR on every poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Course nametext
Employeetext
Completed ondate
Expected timetext
Time spenttext
Training statustext
Test statustext

Watch Contact Tracing Records

TriggerNewly added tracing entries, polled periodically.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Test status IDnumber
Test statustext
Test datedate
Symptoms start datedate
Symptoms end datedate
Contact tracing infoobject
Added ondate

Watch Employee Forms

TriggerEmployee forms noticed since the last check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
Form submission statustext
Submitted ondate
Deadlinedate
Reference IDtext
Form titletext
Form dataarray

Watch Employee KPI Entries

TriggerFresh KPI entries delivered on a schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Performance titletext
Employeetext
Employee user nametext
Created ondate
Employee statustext
Employee submitted ontext
Employee submitted bytext
Line managertext
Line manager user nametext
Line manager statustext

Watch Employee Rehires

TriggerRehire records found by a scheduled check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Exit datedate
Previous company nametext
Previous station nametext
Previous division nametext
Previous department nametext
Previous designationtext

Watch Employee Surveys

TriggerSurveys reported once they are added.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Employeestext
Reference numbertext
Survey deadlinedate
Survey added ondate
Statustext
Progress barnumber
Progresstext

Watch Employees

TriggerEmployees read from WebHR on each poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Access codetext
First nametext
Last nametext
Middle nametext
Full nametext
Email addressemail
Statustext
Designationtext
Employee gradetext

Watch eSignatures

TriggerSignature requests caught during each check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
E signature document IDnumber
Document titletext
E signature typenumber
Document typenumber
Statusnumber
Notify when senttext
Notify when signedtext
Categorytext
Added ondate

Watch eSignatures Documents

TriggerDocuments sent for signature, reported when added.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Document titletext
E signature typetext
Document typetext
Statustext
Notify when senttext
Notify when signedtext
Categorytext
Added ondate

Watch Event Budgets

TriggerEvent budgets noticed on a polling schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Event budget titletext
Budget typetext
Event type titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

Watch Job Candidate Surveys

TriggerCandidate surveys not seen at the last poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Survey nametext
Reference numbertext
Survey added ondate
Survey deadlinedate
Statustext

Watch Job Tests

TriggerJob tests spotted by the periodic check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Descriptiontext
Test timetext
Submit on times update
Notestext
Job test added ondate
Questionsarray
Custom fieldsobject

Watch Notifications

TriggerNotifications picked up by the schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Notification typetext
Send to( employee)text
Send to selftext
Exempt employeestext
Days to send notificationtext
Notification added ondate

Watch Performance Designers

TriggerPerformance designer records found by a poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Performance titletext
Employeetext
Employee user nametext
Designer categorytext
Created ondate
Statustext
Objectivesarray

Watch Plannings

TriggerPlannings reported when they first appear.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Planning titletext
Planning start datedate
Planning end datedate
Planning amounttext
Currencytext
Descriptiontext
Planning itemsarray
Approval statustext
Added ondate

Watch Polls

TriggerNew polls spotted by the schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
First nametext
Last nametext
Questiontext
Answer 1text
Answer 2text
Answer 3text
Answer 4text
Answer 5text
Answer 6text

Watch Quarantine Records

TriggerQuarantine entries that appear between checks.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Start datedate
End datedate
Quarantine facilitytext
Quarantine sponsortext
Purpose of quarantinetext
Statustext
Added ondate

Watch Run Event Budgets

TriggerRun event budgets noticed on each poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Event budget titletext
Budget typetext
Event type titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

Watch Screenings

TriggerScreening entries found by a scheduled check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Start datedate
End datedate
Quarantine facilitytext
Quarantine sponsortext
Purpose of quarantinetext
Statustext
Added ondate

Watch Signed eSignatures Documents

TriggerSigned documents read on a schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employee nametext
Document titletext
E signature sent ondate
E signature signed ondate

Watch Teams

TriggerTeam entries added since the last poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Team titletext
Team leadertext
Team coordinatorstext
Team employeestext
Descriptiontext
Notestext
Team added ondate
Statustext

Watch Transfers

TriggerTransfer entries fetched at each poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Transfer typetext
Transfer datedate
Transfer from stationtext
Transfer to stationtext
Transfer from departmenttext
Transfer to departmenttext

Watch Travel Event Budgets

TriggerTravel event budgets reported once added.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Hr budget travel type titletext
Travel type titletext
Budget titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

Watch Vaccines

TriggerVaccine records noticed in the periodic check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employee IDnumber
Employeetext
User nametext
Vaccine providertext
Vaccine statustext
Shot date 1date
Shot date 2date
Booster shotsarray
Approval statustext
Approval status IDnumber

Watch Visitor Contacts

TriggerVisitor contacts that show up between polls.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitor contact IDnumber
Contact nametext
Companytext
Departmenttext
Phone numbertext
Emailemail
Roomtext
Added ontext
Statustext
Custom fieldsobject

Watch Visitors

TriggerNew visitors since the last scheduled poll.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitor IDnumber
First nametext
Last nametext
Codetext
Company nametext
Email addresstext
Statustext
Flag statustext
Descriptiontext
Visitor added ondate

Watch Visits

TriggerVisit entries read during each check.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitors visit IDnumber
Visitortext
Visit typetext
Hosturl
Datedate
Check intext
Check outtext
Visitor contacttext

Watch Warnings

TriggerWarning entries fetched by the polling schedule.
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Warning by employeetext
Warning to employeetext
Warning datedate
Type of warningtext
Subjecttext

List Achievements

SearchAchievements with their stored details.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
Empoyeetext
Achievement titletext
Achievement datedate

List Announcements

SearchAnnouncements stored in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Announcement titletext
Announcement start datetext
Announcement end datetext
Messagetext
Announcement by emailemail
Notestext

List Asset Order Request

SearchAsset order requests saved in your account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Purchase order request numbertext
Subjecttext
Request datedate
Total amounttext
Vendor IDnumber
Vendor nametext
Approval statustext
Purchase order request itemsarray
Custom fields dataobject

List Asset Purchase Orders

SearchPurchase orders recorded in your account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Purchase order numbertext
Subjecttext
Purchase order datedate
Total amounttext
Vendor IDnumber
Vendor nametext
Purchase order request numbertext
Approval statustext
Purchase order itemsarray
Custom fields dataobject

List Asset Vendors

SearchAsset vendors set up in your account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Vendor nametext
Primary contacttext
Email addressemail
Phone numbertext
Mobile numbertext
Addresstext
Citytext
Zip codetext
Statetext
Countrytext

List Assets

SearchAsset records kept in your account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Asset nametext
Asset codetext
Asset tagtext
Quantitytext
Asset costtext

List Attendance

SearchAttendance records by person, dates or project code.
Input fields[3]
FieldType
UserNametext
StartDatedate
EndDatedate
ProjectCodetext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Transfer typetext
Transfer datedate
Transfer from stationtext
Transfer to stationtext
Transfer from departmenttext
Transfer to departmenttext

List Bookings

SearchReservations in WebHR with level and status filters.
Input fields[3]
FieldType
Titletext
Leveltext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Booking typetext
Leveltext
User nametext
Roomtext
Booking datedate
Start timetext
End timetext
Statustext
Additional infoobject

List Budgets

SearchBudgets from WebHR, filtered by approval, date or user.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Planning titletext
Budget titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext
Added ondate

List Candidate Forms

SearchCandidate form submissions with type and approval filters.
Input fields[3]
FieldType
UserNametext
FormTypetext
Searchtext
ApprovalStatusnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Form typetext
Added ondate

List Candidates

SearchApplicants, optionally narrowed by application date or email.
Input fields[3]
FieldType
Applied On Start Datedate
Applied On End Datedate
Email Addressemail
Allow Custom Fieldsnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
First nametext
Last namenumber
Date of birthtext
Gendernumber
Nationalitynumber
Addressnumber
Citytext
Email addressemail
Phone numbertext
Mobile numbertext

List Check-in Rooms

SearchRooms used for check-in with title and level filters.
Input fields[3]
FieldType
Titletext
Leveltext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Sub categorytext
Leveltext
Roomtext
Room email addresstext
Spacetext
Statustext

List Checkouts

SearchCheckout entries stored in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Asset nametext
Asset codetext
Employeetext
User nametext
Reference numbernumber
Checkout date timedate
Checkin date timedate
Statustext

List Companies

SearchCompanies configured in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Companytext
Company codetext
Legal nametext
Contact numbertext
Fax numbertext
Email addressemail
Websiteurl
Bank nametext
Account titletext
Account numbertext

List Complaints

SearchComplaints that were filed in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
Empoyeetext
Titletext
Complaint datedate
Complaint againsttext

List Completed Courses

SearchCourses marked as completed in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Course nametext
Employeetext
Completed ondate
Expected timetext
Time spenttext
Training statustext
Test statustext

List Contact Tracing

SearchContact tracing records, filterable by date and user.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Test status IDnumber
Test statustext
Test datedate
Symptoms start datedate
Symptoms end datedate
Contact tracing infoobject
Added ondate

List Cost Centers

SearchCost centers configured for your organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Cost center nametext
Cost center codetext
Cost center headtext
Notestext

List Custom Fields

SearchCustom field definitions with their category, order and position.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Record IDtext
Component nametext
Custom field nametext
Custom field categorytext
Mandatory fieldtext
Custom field typetext
Custom field ordertext
Custom field positiontext
Custom field type valuestext

1other output field

List Departments

SearchDepartments of the organisation with their details.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Companytext
Divisiontext
Stationtext
Department nametext
Department codetext
Department headtext
Parent departmenttext
Statustext

List Divisions

SearchDivisions that make up the organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Companytext
Division typetext
Division nametext
Division head user nametext
Division codetext
Division headtext
Statustext

List Employee Exits

SearchExit entries for staff in a chosen window.
Input fields[3]
FieldType
Start Datedate
End Datedate
Allow Custom Fieldsnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Exit datedate
Company nametext
Station nametext
Division nametext
Exit typetext
Exit interview conductedtext

List Employee Forms

SearchEmployee forms, filterable by person and type.
Input fields[3]
FieldType
UserNametext
FormTypetext
Searchtext
ApprovalStatusnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
Form submission statustext
Submitted ondate
Deadlinedate
Reference IDtext
Form titletext
Form dataarray

List Employee Grade

SearchGrade names that can be searched by partial text.
Input fields[3]
FieldType
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employee gradetext

List Employee Hours

SearchLogged time by employee and date.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Yeartext
Employeetext
User nametext
Access codetext
Employee typetext
Employee categorytext
Leave typetext
Entitledtext
Accruedtext
Carried overtext

List Employee KPI

SearchKPI results per employee.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Performance titletext
Employeetext
Employee user nametext
Created ondate
Employee statustext
Employee submitted ontext
Employee submitted bytext
Line managertext
Line manager user nametext
Line manager statustext

List Employee Rehire

SearchEmployees who were rehired, optionally for a single user.
Input fields[3]
FieldType
UserNametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Exit datedate
Previous company nametext
Previous station nametext
Previous division nametext
Previous department nametext
Previous designationtext

List Employee Survey

SearchEmployee surveys, filterable by status and end date.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Employeestext
Reference numbertext
Survey deadlinedate
Survey added ondate
Statustext
Progress barnumber
Progresstext

List Employee Trainings

SearchTraining entries kept for your staff.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Training typetext
Training subjecttext
Training titletext
Date fromdate
Date todate

List Employee Types

SearchTypes of employee defined in WebHR.
Input fields[3]
FieldType
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employee typetext

List Employees

SearchStaff records, one entry for each employee.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Access codetext
First nametext
Last nametext
Middle nametext
Full nametext
Email addressemail
Statustext
Designationtext
Employee gradetext

List eSignature

SearchRequests for electronic signature.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
E signature document IDnumber
Document titletext
E signature typenumber
Document typenumber
Statusnumber
Notify when senttext
Notify when signedtext
Categorytext
Added ondate

List eSignature Documents

SearchDocuments out for electronic signature.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Document titletext
E signature typetext
Document typetext
Statustext
Notify when senttext
Notify when signedtext
Categorytext
Added ondate

List Events Budgets

SearchEvent budget entries with approval filters.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Event budget titletext
Budget typetext
Event type titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

List Expirations

SearchExpiration entries, filterable by status.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Expiration titletext
Expiration type titletext
Expiration fortext
Employee nametext
User nametext
Descriptiontext
Expiration datedate
Due datedate
Critical datedate
Statustext

List Incidents

SearchIncidents that were logged in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
First nametext
Last nametext
Category typetext
Incident typetext
Titletext
Incident datedate
Incidentt timetext
Approval statustext

List Job Candidates Survey

SearchJob candidate surveys with user and text filters.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Survey nametext
Reference numbertext
Survey added ondate
Survey deadlinedate
Statustext

List Job Requests

SearchJob requests stored by your organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Job titletext
Reference numbernumber
Job typetext
Number of positionsnumber
Candidate age range startnumber
Candidate age range endnumber
Candidate experiencetext
Candidate qualificationtext
Descriptiontext
Salary start rangetext

List Job Tests

SearchJob tests with optional date and user filters.
Input fields[3]
FieldType
Allow Custom Fieldsnumber
Start Datetext
End Datetext
User Nametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Descriptiontext
Test timetext
Submit on times update
Notestext
Job test added ondate
Questionsarray
Custom fieldsobject

List Jobs

SearchJobs with date and user filters.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Allow Custom Fieldsnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Job titletext
Reference numbertext
Job typetext
Number of positionsnumber
Candidate age range startnumber
Candidate age range endnumber
Candidate experiencetext
Candidate qualificationtext
Descriptiontext
Salary start rangetext

List Leave Quota

SearchLeave quotas filtered by year, type and person.
Input fields[3]
FieldType
Yeartext
User Nametext
Leave Typetext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Yeartext
Employeetext
User nametext
Access codetext
Employee typetext
Employee categorytext
Leave typetext
Entitledtext
Accruedtext
Carried overtext

List Leaves

SearchLeave requests by person, status or dates.
Input fields[3]
FieldType
User Nametext
Start Datedate
End Datedate
Approval Statustext
Allow Custom Fieldsnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Reasontext
Reference numbertext
Leave typetext
Lunch break out timetext
Leave fromtext
Leave totext

List Loans

SearchEmployee loans, filterable by user, dates and approval status.
Input fields[3]
FieldType
UserNametext
StartDatedate
EndDatedate
ApprovalStatustext
AllowCustomFieldsnumber
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Titletext
Loan amounttext
Remaining amounttext
Monthly repayment amounttext
Repayments typetext
Repayments monthstext
Loan datedate
Repayment start datedate

List Lost and Found Assets

SearchLost and found asset entries for a chosen period.
Input fields[3]
FieldType
StartDatedate
EndDatedate
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Itemtext
Reference numbertext
Stagetext
Lost bytext
Found bytext
Item lost datedate
Item lost timetext
Item lost locationtext
Item lost stationtext
Item found datedate

List Memos

SearchMemos stored in your WebHR account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employeetext
Memo datedate
Subjecttext
Memo totext

List Notifications

SearchNotifications kept for your WebHR account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Notification typetext
Send to( employee)text
Send to selftext
Exempt employeestext
Days to send notificationtext
Notification added ondate

List Open Positions

SearchOpen positions in WebHR with user and text filters.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Open position codenumber
Open position titletext
Statustext
Estimated salarytext
Company nametext
Division nametext
Station nametext
Department nametext
Approval statustext
Custom fieldsobject

List Parent Departments

SearchParent departments held by the organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Parent department nametext
Parent department headtext
Parent department added ontext

List Payslip

SearchPayslips for a chosen pay period.
Input fields[3]
FieldType
Payslip Start Monthtext
Payslip Start Yeartext
Payslip End Monthtext
Payslip End Yeartext
Companytext
Divisiontext
Stationtext
Department Nametext
Show Leave Salarynumber

5other input fields

Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Company nametext
Station nametext
Division nametext
User nametext
Access codetext
First nametext
Last nametext
Full nametext
Nationalitytext
Position codetext

List Pending Courses

SearchPending courses still to be finished.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Course nametext
Employeetext
Course deadlinedate
Time spenttext
Progresstext

List Pending Reviews

SearchPending reviews with user and date filters.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Performance titletext
Review fortext
Review for user nametext
Review bytext
Review by user nametext
Review complete bytext
Review typetext
Approval statustext

List Performance Designer

SearchPerformance designer records, filterable by period.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Performance titletext
Employeetext
Employee user nametext
Designer categorytext
Created ondate
Statustext
Objectivesarray

List Plannings

SearchPlannings with approval and user filters.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Planning titletext
Planning start datedate
Planning end datedate
Planning amounttext
Currencytext
Descriptiontext
Planning itemsarray
Approval statustext
Added ondate

List Policies

SearchThe policies kept in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Policy titletext
Policy typetext
Descriptiontext
Notestext
Policy added ontext
Statustext
Custom fieldsobject

List Polls

SearchPolls with status and date filters.
Input fields[3]
FieldType
Start datedate
End datedate
Usernametext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
First nametext
Last nametext
Questiontext
Answer 1text
Answer 2text
Answer 3text
Answer 4text
Answer 5text
Answer 6text

List Project Clients

SearchClient entries linked to projects.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Client nametext
First nametext
Last nametext
Email addressemail
Phone numbertext
Addresstext
Citytext
Statetext
Countrytext
Zip codetext

List Project Tasks

SearchTask entries belonging to projects.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Tasktext
Task typetext
Project titletext
Client nametext
Task start datedate
Task end datedate
Deadlinetext
Assigned toarray

List Projects

SearchProject entries stored in your account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Record IDtext
Project titletext
Project codetext
Client nametext
Project category nametext
Project start datedate
Project end datedate
Project managertext
Project coordinatortext
Project employeestext

List Promotions

SearchPromotions between two dates.
Input fields[3]
FieldType
Allow Custom Fieldstext
Searchtext
Start Datedate
End Datedate
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
First nametext
Last nametext
Titletext
Promotion datedate
Promotion type titletext
Employee designation fromtext
Employee designation totext
Employee grade fromtext
Employee grade totext

List Quarantine

SearchQuarantine entries filtered by status or date.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Start datedate
End datedate
Quarantine facilitytext
Quarantine sponsortext
Purpose of quarantinetext
Statustext
Added ondate

List Reminders

SearchReminders that were saved in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Reminder titletext
Reminder typetext
Reminder datetext
Send reminder to( employee)text
Reminder employeestext
Messagetext
Statustext

List Resignations

SearchResignations stored for your organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
Empoyeetext
Resignation datedate
Notice datedate

List Rooms

SearchWorkplace rooms filterable by title, level and status.
Input fields[3]
FieldType
Titletext
Leveltext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Sub categorytext
Leveltext
Roomtext
Room email addresstext
Spacetext
Statustext

List Run Events Budgets

SearchRun event budget entries filtered by user or end date.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Event budget titletext
Budget typetext
Event type titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

List Salaries

SearchSalaries per employee, searchable by text.
Input fields[3]
FieldType
User Nametext
Allow Custom Fieldsnumber
Allow Salary Allocationnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Payroll setuptext
Salary typetext
Currencytext
Annual gross salarytext
Monthly gross salarytext
Hourly salarytext
Overtime hourly salarytext
Hours per weektext

List Schedule Planner

SearchEntries stored in the schedule planner.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employeetext
Planned schedulesarray

List Schedule Templates

SearchTemplates searchable by title or text.
Input fields[3]
FieldType
Titletext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Titletext
Station nametext
Work daysarray
Work hoursobject
Regular work hoursobject
Additional infoobject
Notestext
Schedule template added ontext
Schedule template added bytext

List Schedules

SearchSchedules recorded for a person and period.
Input fields[3]
FieldType
Usernametext
Start datedate
End datedate
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employeetext
Scheduler datedate
Time fromtext
Time totext
Titletext
Stationtext
Designationtext
Projecttext
Workshifttext

List Screening

SearchScreening entries searchable by text and status.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Start datedate
End datedate
Quarantine facilitytext
Quarantine sponsortext
Purpose of quarantinetext
Statustext
Added ondate

List Screening Interviews

SearchScreening interviews held in your WebHR account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Interview typetext
Interview datedate
Interview timetext
Place of interviewtext
Candidate nametext
Candidate email addressemail
Candidate reference numbernumber

List Signed eSignature Documents

SearchSigned documents, filterable by user and start date.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employee nametext
Document titletext
E signature sent ondate
E signature signed ondate

List Stations

SearchStation entries held in the organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Station nametext
Station codetext
Addresstext
Citytext
Statetext
Zip codetext
Countrytext
Phone numbertext
Fax numbertext
Email addressemail

List Stocks

SearchStock entries filtered by approval state and person.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employeetext
User nametext
Titletext
Amounttext
Number of sharestext
Price per sharetext
Stock grant datedate
Reference numbertext
Approval statustext

List Suggestions

SearchSuggestions stored on your WebHR account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employeetext
Titletext

List Target Hours

SearchTarget hours as configured in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
User nametext
Employeetext
Target hoursnumber
Start datedate
End datedate

List Teams

SearchTeams that exist in WebHR.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Team titletext
Team leadertext
Team coordinatorstext
Team employeestext
Descriptiontext
Notestext
Team added ondate
Statustext

List Terminations

SearchTerminations in a date range.
Input fields[3]
FieldType
Allow Custom Fieldstext
Searchtext
Start Datedate
End Datedate
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
Empoyeetext
Termination typetext
Termination datedate
Notice datedate

List Trainers

SearchTrainers by course and location.
Input fields[3]
FieldType
Course Nametext
Course Category Nametext
Training Locationtext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Trainer IDnumber
Trainer typetext
Trainer nametext
Designationtext
Organizationtext

List Training Courses

SearchCourses searchable by name, category and place.
Input fields[3]
FieldType
Course Nametext
Course Category Nametext
Training Locationtext
Statusnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Course IDnumber
Course nametext
Course categorytext
Training locationtext
Expected timetext
Allow self trainingtext
Take testtext
Statustext

List Transfers

SearchTransfer records for one or all employees.
Input fields[3]
FieldType
UserNametext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Usernametext
First nametext
Last nametext
Full nametext
Transfer typetext
Transfer datedate
Transfer from stationtext
Transfer to stationtext
Transfer from departmenttext
Transfer to departmenttext

List Travel Budgets

SearchTravel budget entries searchable by text and date.
Input fields[3]
FieldType
User nametext
Start datedate
End datedate
Approval statustext
Allow custom fieldsnumber
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Hr budget travel type titletext
Travel type titletext
Budget titletext
Budget start datedate
Budget end datedate
Budget amounttext
Reference numbertext
Currencytext
Descriptiontext
Approval statustext

List Vaccine

SearchVaccination entries filtered by status, user and date.
Input fields[3]
FieldType
Start Datedate
End Datedate
User Nametext
Statustext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Employee IDnumber
Employeetext
User nametext
Vaccine providertext
Vaccine statustext
Shot date 1date
Shot date 2date
Booster shotsarray
Approval statustext
Approval status IDnumber

List Visitor Contacts

SearchContact entries of visitors by name and text.
Input fields[3]
FieldType
Start Datedate
End Datedate
First Nametext
Last Nametext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitor contact IDnumber
Contact nametext
Companytext
Departmenttext
Phone numbertext
Emailemail
Roomtext
Added ontext
Statustext
Custom fieldsobject

List Visitors

SearchVisitors by name and date.
Input fields[3]
FieldType
Start Datedate
End Datedate
First Nametext
Last Nametext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitor IDnumber
First nametext
Last nametext
Codetext
Company nametext
Email addresstext
Statustext
Flag statustext
Descriptiontext
Visitor added ondate

List Visits

SearchVisit entries up to a chosen end date.
Input fields[3]
FieldType
Start Datedate
End Datedate
First Nametext
Last Nametext
Searchtext
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Visitors visit IDnumber
Visitortext
Visit typetext
Hosturl
Datedate
Check intext
Check outtext
Visitor contacttext

List Warnings

SearchWarnings kept in your WebHR account.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Field IDtext
Data fieldsobject
Warning by employeetext
Warning to employeetext
Warning datedate
Type of warningtext
Subjecttext

Add a Booking

ActionCreates a room booking with its date, times and participants.
Input fields[3]
FieldType
Booking Datedate
Start Timetime
End Timetime
Titletext
Room IDchoice
Employee IDchoice
Participantstext
Added Bynumber
Outlook Meeting IDtext

2other input fields

Output fields[3]
FieldType
Messagetext

Add a Leave Request

ActionFiles leave requests for employees.
Input fields[3]
FieldType
Leave Dataarray
UserNametext
Leave Fromdate
Leave Todate
Leave Typetext
Leave Durationtext
Output fields[3]
FieldType
Messagetext

Add a Performance Designer

ActionDefines a performance designer with objectives and KPIs.
Input fields[3]
FieldType
Performance Designer Dataobject
Performance Titletext
Objective KPIsarray
Output fields[3]
FieldType
Messagetext

Add a Poll

ActionNew poll with up to six answers and a run period.
Input fields[3]
FieldType
QuestionRequired
text
Answer 1Required
text
Answer 2Required
text
Poll Start DateRequired
date
Poll End DateRequired
date
Answer 3text
Answer 4text
Answer 5text
Answer 6text

2other input fields

Output fields[3]
FieldType
Messagetext

Add a Ticket

ActionRaises a ticket in a category with priority and deadline.
Input fields[3]
FieldType
Ticket Category IDchoice
Prioritytext
Subjecttext
Messagetext
Deadlinedate
Created Bytext
Output fields[3]
FieldType
Messagetext

Add an Attendance Entry

ActionLogs time and attendance records.
Input fields[3]
FieldType
Dataarray
Access Codetext
Datedate
Timedate
Typetext
Work Shifttext
Scheduler IDnumber
Output fields[3]
FieldType
Messagetext

Add an Employee

ActionCreates an employee with company, department and personal details.
Input fields[3]
FieldType
Company Nametext
Division Nametext
Station Nametext
Department Nametext
Designationtext
Gradetext
Work Shifttext
Employee Categorytext
Employee Typetext

38other input fields

Output fields[3]
FieldType
Messagetext

Add Candidates

ActionRegisters a candidate with personal and contact details.
Input fields[3]
FieldType
Candidate Dataarray
Output fields[3]
FieldType
Messagetext

Add Employee Hours

ActionTime entry with regular and overtime hours.
Input fields[3]
FieldType
User nametext
Employee IDtext
Projecttext
Project IDtext
Project task IDtext
Employee hours datedate
Regular hourstext
Overtime hourstext
Descriptiontext

1other input field

Output fields[3]
FieldType
Messagetext

Add Project Clients

ActionCreates several project clients at once.
Input fields[3]
FieldType
Project Clientsarray
Client Nametext
First Nametext
Last Nametext
Email Addressemail
Phone Numbertext
Addresstext
Citytext
Statetext
Countrytext
ZIP Codetext
Output fields[3]
FieldType
Messagetext

Add Project Tasks

ActionCreates project tasks from a JSON array.
Input fields[3]
FieldType
Dataarray
Tasktext
Task Typetext
Project Titletext
Deadlinedate
Assigned Toarray
Task Start Datedate
Task End Datedate
Task Start Timetext
Task End Timetext
Max Hours Bytext
Output fields[3]
FieldType
Messagetext

Add Projects

ActionStarts a new project with a title and employees.
Input fields[3]
FieldType
Dataarray
ProjectTitletext
ProjectEmployeesarray
Output fields[3]
FieldType
Messagetext

Delete Employee Hours

ActionDeletes a logged time entry of an employee.
Input fields[3]
FieldType
Field IDsRequired
choice

Delete Project Clients

ActionRemoves a client from the project client records.
Input fields[3]
FieldType
Field IDRequired
choice

Delete Project Tasks

ActionRemoves a task from the task list of a project.
Input fields[3]
FieldType
Field IDRequired
choice
Output fields[3]
FieldType
Messagetext

Delete Projects

ActionDeletes a saved project from your account.
Input fields[3]
FieldType
Project IDsRequired
choice

Make an API Call

universalFree-form WebHR REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Update Employee Hours

ActionCorrects an earlier hours entry.
Input fields[3]
FieldType
Field IDRequired
choice
User nametext
Employee IDtext
Projecttext
Project IDtext
Project task IDtext
Employee hours datedate
Regular hourstext
Overtime hourstext

2other input fields

Output fields[3]
FieldType
Messagetext

Update Project Clients

ActionRevises contact information for a project client.
Input fields[3]
FieldType
Field IDRequired
choice
Project Clientsarray
Client Nametext
First Nametext
Last Nametext
Email Addressemail
Phone Numbertext
Addresstext
Citytext
Statetext
Countrytext
ZIP Codetext
Output fields[3]
FieldType
Messagetext

Update Project Tasks

ActionEdits the schedule and assignees of a task.
Input fields[3]
FieldType
Field IDRequired
choice
Tasktext
Task Typetext
Project Titletext
Deadlinedate
Assigned Toarray
Task Start Datedate
Task End Datedate
Task Start Timetext

8other input fields

Output fields[3]
FieldType
Messagetext

Update Projects

ActionRenames a project or changes its employees.
Input fields[3]
FieldType
Project IDRequired
choice
ProjectTitletext
ProjectEmployeesarray
Output fields[3]
FieldType
Messagetext

Look for WebHR templates in the WEXTL template library.

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

Last updated: Oct 31, 2026 15:34

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.