Requirements
To use HomeBase on WEXTL you need an active account and an API access token from your account settings.[3]
Get your HomeBase credentials
- API KeypasswordRequired
You can request a key from the the API Settings page within the app.
[1]
Connect HomeBase in WEXTL
- Log in to your WEXTL account, add the HomeBase node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your HomeBase account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
HomeBase node modules
The list below is a reference of every HomeBase node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any HomeBase node module below to inspect its input parameters, outputs, and connection requirements.
Get a LocationAction
Get a Location PlanAction
Get a ShiftAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Shift IDRequired | text |
| With Note | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Timecard ID | number |
| Open | boolean |
| Role | text |
| Department | text |
| First Name | text |
| Last Name | text |
| Location ID | number |
| Job ID | number |
| User ID | number |
| Wage Rate | number |
| Published | boolean |
| Scheduled | boolean |
| Labor | object |
| Wage Type | text |
| Scheduled Hours | number |
| Scheduled Overtime | number |
| Scheduled Regular | number |
| Scheduled Daily Overtime | number |
| Scheduled Weekly Overtime | number |
| Scheduled Double Overtimes | number |
| Scheduled Seventh Day Overtime 15 | number |
| Scheduled Seventh Day Overtime 20 | number |
| Scheduled Unpaid Breaks Hours | number |
| Created at | date |
| Updated at | date |
| Start at | date |
| End at | date |
| Note | object |
| Text | text |
| Author | text |
Get a TimecardAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Timecard IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| User ID | number |
| First Name | text |
| Last Name | text |
| Payroll ID | text |
| Job ID | number |
| Shift ID | number |
| Role | text |
| Department | text |
| Timebreaks | array |
| Labor | object |
| Wage Type | text |
| Break Penalty | number |
| Costs | number |
| Cash Tips | number |
| Credit Tips | number |
| Weekly Overtime | number |
| Paid Time Off Hours | number |
| Time Off Hours | number |
| Unpaid Break Hours | number |
| Regular Hours | number |
| Approved | boolean |
| Created at | date |
| Updated at | date |
| Clock In | date |
| Clock Out | date |
Get an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Employee IDRequired | text |
| With Archived | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First Name | text |
| Last Name | text |
| Phone | text |
| Job | object |
| ID | number |
| Level | text |
| Default Role | text |
| Pin | text |
| Pos Partner ID | text |
| Payroll ID | text |
| Wage Rate | number |
| Wage Type | text |
| Roles | array |
| Archived at | date |
| Created at | date |
| Updated at | date |
Get Labor OperationsAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
Output fields[3]
| Field | Type |
|---|---|
| Role ID | text |
| Role Name | text |
| Labor | object |
| Wage Type | text |
| Break Penalty | number |
| Costs | number |
| Cash Tips | number |
| Credit Tips | number |
| Weekly Overtime | number |
| Paid Time Off Hours | number |
| Time Off Hours | number |
| Unpaid Break Hours | number |
| Regular Hours | number |
Get Labor OperationsAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
Group ByRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Role ID | text |
| Role Name | text |
| Labor | object |
| Wage Type | text |
| Break Penalty | number |
| Costs | number |
| Cash Tips | number |
| Credit Tips | number |
| Weekly Overtime | number |
| Paid Time Off Hours | number |
| Time Off Hours | number |
| Unpaid Break Hours | number |
| Regular Hours | number |
Get Labor OperationsAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
Output fields[3]
| Field | Type |
|---|---|
| Role ID | text |
| Role Name | text |
| Labor | object |
| Wage Type | text |
| Break Penalty | number |
| Costs | number |
| Cash Tips | number |
| Credit Tips | number |
| Weekly Overtime | number |
| Paid Time Off Hours | number |
| Time Off Hours | number |
| Unpaid Break Hours | number |
| Regular Hours | number |
List LocationsSearch
Search Deleted ShiftsSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Timecard ID | number |
| Open | boolean |
| Role | text |
| Department | text |
| First Name | text |
| Last Name | text |
| Location ID | number |
| Job ID | number |
| User ID | number |
| Wage Rate | number |
| Published | boolean |
| Scheduled | boolean |
| Labor | object |
| Wage Type | text |
| Scheduled Hours | number |
| Scheduled Overtime | number |
| Scheduled Regular | number |
| Scheduled Daily Overtime | number |
| Scheduled Weekly Overtime | number |
| Scheduled Double Overtimes | number |
| Scheduled Seventh Day Overtime 15 | number |
| Scheduled Seventh Day Overtime 20 | number |
| Scheduled Unpaid Breaks Hours | number |
| Created at | date |
| Updated at | date |
| Start at | date |
| End at | date |
| Note | object |
| Text | text |
| Author | text |
Search Deleted TimecardsSearch
Search EmployeesSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
| With Archived | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First Name | text |
| Last Name | text |
| Phone | text |
| Job | object |
| ID | number |
| Level | text |
| Default Role | text |
| Pin | text |
| Pos Partner ID | text |
| Payroll ID | text |
| Wage Rate | number |
| Wage Type | text |
| Roles | array |
| Archived at | date |
| Created at | date |
| Updated at | date |
Search ShiftsSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
| Open | boolean |
| With Note | boolean |
Date FilterRequired | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Timecard ID | number |
| Open | boolean |
| Role | text |
| Department | text |
| First Name | text |
| Last Name | text |
| Location ID | number |
| Job ID | number |
| User ID | number |
| Wage Rate | number |
| Published | boolean |
| Scheduled | boolean |
| Labor | object |
| Wage Type | text |
| Scheduled Hours | number |
| Scheduled Overtime | number |
| Scheduled Regular | number |
| Scheduled Daily Overtime | number |
| Scheduled Weekly Overtime | number |
| Scheduled Double Overtimes | number |
| Scheduled Seventh Day Overtime 15 | number |
| Scheduled Seventh Day Overtime 20 | number |
| Scheduled Unpaid Breaks Hours | number |
| Created at | date |
| Updated at | date |
| Start at | date |
| End at | date |
| Note | object |
| Text | text |
| Author | text |
Search TimecardsSearch
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Start DateRequired | date |
End DateRequired | date |
| Date Filter | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| User ID | number |
| First Name | text |
| Last Name | text |
| Payroll ID | text |
| Job ID | number |
| Shift ID | number |
| Role | text |
| Department | text |
| Timebreaks | array |
| Labor | object |
| Wage Type | text |
| Break Penalty | number |
| Costs | number |
| Cash Tips | number |
| Credit Tips | number |
| Weekly Overtime | number |
| Paid Time Off Hours | number |
| Time Off Hours | number |
| Unpaid Break Hours | number |
| Regular Hours | number |
| Approved | boolean |
| Created at | date |
| Updated at | date |
| Clock In | date |
| Clock Out | date |
Create a LocationAction
Input fields[3]
| Field | Type |
|---|---|
Location NameRequired | text |
Location ZipRequired | text |
Location Address 1Required | text |
| Location Address 2 | text |
| Location Phone | text |
| Location Website | text |
| Location Merchant ID | text |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Name | text |
| Address 1 | text |
| Address 2 | text |
| City | text |
| State | text |
| Zip | text |
| Country Code | text |
| Phone | text |
| Website | text |
| Time Zone | text |
| Partner Merchant ID | text |
| Created at | date |
| Updated at | date |
Create a Location SaleAction
Create an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
| Phone | text |
| Job Level | choice |
| Job Wage Rate | number |
| Job Default Role | text |
| Job Pin | number |
| Job POS Partner ID | text |
| Job Payroll ID | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First Name | text |
| Last Name | text |
| Phone | text |
| Job | object |
| ID | number |
| Level | text |
| Default Role | text |
| Pin | text |
| Pos Partner ID | text |
| Payroll ID | text |
| Wage Rate | number |
| Wage Type | text |
| Roles | array |
| Archived at | date |
| Created at | date |
| Updated at | date |
Make an API Calluniversal
Update an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Location IDRequired | choice |
Employee IDRequired | text |
| First Name | text |
| Last Name | text |
| Phone | text |
| Job Level | choice |
| Job Wage Rate | number |
| Job Default Role | text |
| Job Pin | number |
| Job POS Partner ID | text |
| Job Payroll ID | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First Name | text |
| Last Name | text |
| Phone | text |
| Job | object |
| ID | number |
| Level | text |
| Default Role | text |
| Pin | text |
| Pos Partner ID | text |
| Payroll ID | text |
| Wage Rate | number |
| Wage Type | text |
| Roles | array |
| Archived at | date |
| Created at | date |
| Updated at | date |
Templates
Look for HomeBase templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BuddyPunch[2]Employee time clock and attendance tracking for hourly teams.
- CalamariHR leave, attendance, and timesheet management for growing teams.
- Base.vnWorkplace suite for HR, requests, meetings, time off, and team operations.
- BrioHRHR management platform for employee data, leave, payroll-ready records, and people operations.
- Breathe HRCloud HR software for employee records, leave, onboarding, and people management.
References
- WEXTL® HomeBase Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for HomeBase.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:11