Requirements
Before you set up the credential, make sure you have an active Payworks account and OAuth client credentials, granted by signing in with your account ready.[3]
Get your Payworks credentials
Credential type option 1
Payworks (Payrolls)
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
- Client SecretpasswordRequired
- Paywork Customer NumbertextRequired
Paywork Customer Number associated to your Client Credentials
[1] - URLhidden
Credential type option 2
Payworks (Employees)
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
- Client SecretpasswordRequired
- Paywork Customer NumbertextRequired
Paywork Customer Number associated to your Client Credentials
[1] - URLhidden
Credential type option 3
Payworks (Reports)
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
- Client SecretpasswordRequired
- Paywork Customer NumbertextRequired
Paywork Customer Number associated to your Client Credentials
[1] - URLhidden
Credential type option 4
Payworks (Absence Management)
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
- Client SecretpasswordRequired
- Paywork Customer NumbertextRequired
Paywork Customer Number associated to your Client Credentials
[1] - URLhidden
Credential type option 5
Payworks (Time Management)
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
- Client SecretpasswordRequired
- Paywork Customer NumbertextRequired
Paywork Customer Number associated to your Client Credentials
[1] - URLhidden
Connect Payworks in WEXTL
- Log in to your WEXTL account, add the Payworks 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 Payworks 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 →
Payworks node modules
The list below is a reference of every Payworks node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Payworks node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch HolidaysTrigger
Output fields[3]
| Field | Type |
|---|---|
| Holiday ID | number |
| Calendar ID | number |
| Holiday date | date |
| Observed date | date |
| Is observed | boolean |
| English name | text |
| French name | text |
| Name | text |
Watch Pay PeriodsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Schedule ID | number |
| Year | number |
| Pay processing date | date |
| Pay period start date | date |
| Pay period end date | date |
| Payment date | date |
| Run date time | date |
| Pay period number | number |
| Pay group name | text |
| Pay group name french | text |
| Run type | text |
| Has preview been run | boolean |
Watch SchedulesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| English name | text |
| French name | text |
| Created date | date |
| Earliest shift date | text |
| Published up to date | text |
| Last published date | text |
| Owner | text |
| Is archived | boolean |
| Is deleted | boolean |
| Available shifts enabled | boolean |
| Available shifts position restriction enabled | boolean |
| Available shifts auto approval enabled | boolean |
| Drop shifts enabled | boolean |
| Drop shifts auto approval enabled | boolean |
| Drop threshold minutes | number |
| Exceptions | object |
| Pay groups | array |
| Departments | array |
| Positions | array |
| Employees | array |
Watch Timeoff RequestsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Request ID | number |
| Group ID | text |
| Employee ID | number |
| Employee name | text |
| Time off type ID | number |
| Time off type name | text |
| Status | text |
| Start time | date |
| End time | date |
| Deducted minutes | number |
Watch TimesheetsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee ID | number |
| Earning description | text |
| Start date time | date |
| End date time | date |
| Hours | number |
| Exception department | text |
| Exception cost centre | text |
| Exception rate | number |
| Status | text |
| Changed by | text |
| Saved date | date |
| Schedule ID | number |
| Position | text |
Create a Schedule ShiftSearch
Get a ScheduleAction
Input fields[3]
| Field | Type |
|---|---|
Schedule IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| English name | text |
| French name | text |
| Created date | date |
| Earliest shift date | text |
| Published up to date | text |
| Last published date | text |
| Owner | text |
| Is archived | boolean |
| Is deleted | boolean |
| Available shifts enabled | boolean |
| Available shifts position restriction enabled | boolean |
| Available shifts auto approval enabled | boolean |
| Drop shifts enabled | boolean |
| Drop shifts auto approval enabled | boolean |
| Drop threshold minutes | number |
| Exceptions | object |
| Pay groups | array |
| Departments | array |
| Positions | array |
| Employees | array |
Get a Schedule ShiftAction
Get an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Employee | object |
| Employee ID | number |
| Employee number | text |
| Salutation | text |
| First name | text |
| Middle name | text |
| Preferred name | text |
| Last name | text |
| Preferred last name | text |
| Employment type option | text |
| Payroll status | text |
| Employee contact | object |
| Primary address | text |
| Secondary address | text |
| Primary city | text |
| Secondary city | text |
| Primary postal code | text |
| Secondary postal code | text |
| Primary province | text |
| Secondary province | text |
| Work email address | text |
| Personal email address | text |
| Employee dates | object |
| Start date | text |
| Termination date | text |
| Seniority date | text |
| Insurable date | text |
| Employee organization | object |
| Business number | text |
| Provincial business number | text |
| Pay group | text |
| Employee personal | object |
| Citizenship | text |
| Language preference | text |
| Employee phone number | object |
| Office phone | text |
| Home phone | text |
| Cell phone | text |
| Fax | text |
| Pager | text |
| Employee sensitive | object |
| Birth date | text |
| Gender | text |
| Gender code | text |
| Employee sin | object |
| Sin | text |
| Employee tax | object |
| Tax province | text |
| Federal personal tax exemption | number |
| Provincial personal tax exemption | number |
| Additional tax | number |
| Additional provincial tax | number |
| Annual exempt expenses | number |
| Annual provincial exempt expenses | number |
| Authorized federal tax credit | number |
| Authorized provincial tax credit | number |
| T d1x estimated annual income for commission | number |
| Employment | object |
| Primary earning description | text |
| Occupation | text |
| Hours per pay | number |
| Contract business number | number |
| Security level | number |
| Home cost centre | text |
| Home department | text |
| Employee rate | array |
Get EmployeesSearch
Input fields[3]
| Field | Type |
|---|---|
| Employee IDs | choice |
| Employee Number | array |
| Employee Number | text |
| Payroll Status | array |
| Payroll Status | text |
| Expand | choice |
| Bypass Default Filter | boolean |
| Include Deleted Employees | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Employee | object |
| Employee ID | number |
| Employee number | text |
| Salutation | text |
| First name | text |
| Middle name | text |
| Preferred name | text |
| Last name | text |
| Preferred last name | text |
| Employment type option | text |
| Payroll status | text |
| Employee contact | object |
| Primary address | text |
| Secondary address | text |
| Primary city | text |
| Secondary city | text |
| Primary postal code | text |
| Secondary postal code | text |
| Primary province | text |
| Secondary province | text |
| Work email address | text |
| Personal email address | text |
| Employee dates | object |
| Start date | text |
| Termination date | text |
| Seniority date | text |
| Insurable date | text |
| Employee organization | object |
| Business number | text |
| Provincial business number | text |
| Pay group | text |
| Employee personal | object |
| Citizenship | text |
| Language preference | text |
| Employee phone number | object |
| Office phone | text |
| Home phone | text |
| Cell phone | text |
| Fax | text |
| Pager | text |
| Employee sensitive | object |
| Birth date | text |
| Gender | text |
| Gender code | text |
| Employee sin | object |
| Sin | text |
| Employee tax | object |
| Tax province | text |
| Federal personal tax exemption | number |
| Provincial personal tax exemption | number |
| Additional tax | number |
| Additional provincial tax | number |
| Annual exempt expenses | number |
| Annual provincial exempt expenses | number |
| Authorized federal tax credit | number |
| Authorized provincial tax credit | number |
| T d1x estimated annual income for commission | number |
| Employment | object |
| Primary earning description | text |
| Occupation | text |
| Hours per pay | number |
| Contract business number | number |
| Security level | number |
| Home cost centre | text |
| Home department | text |
| Employee rate | array |
Get HolidaysSearch
Get Journal Entries by Schedule IDAction
Input fields[3]
| Field | Type |
|---|---|
Schedule IDRequired | number |
Output fields[3]
| Field | Type |
|---|---|
| Company | object |
| Company name | text |
| Company name french | text |
| Company number | text |
| Payment date | text |
| Period ending date | text |
| Reference number | number |
| Pay period number | number |
| Run date time | text |
| Pay group name | text |
| Pay group name french | text |
| Credits | object |
| Item | array |
| Debits | object |
| Department | object |
| Totals | object |
| Description | text |
| Description french | text |
| Credit | text |
Get Pay PeriodsSearch
Input fields[3]
| Field | Type |
|---|---|
| Pay Group Name | text |
| Year | number |
| Run Type | choice |
| Payment Date | date |
| Pay Period Number | number |
| Pay Processing Date | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Schedule ID | number |
| Year | number |
| Pay processing date | date |
| Pay period start date | date |
| Pay period end date | date |
| Payment date | date |
| Run date time | date |
| Pay period number | number |
| Pay group name | text |
| Pay group name french | text |
| Run type | text |
| Has preview been run | boolean |
Get Pay StatementsSearch
Get Pay StatementsSearch
Get Schedule ShiftsSearch
Input fields[3]
| Field | Type |
|---|---|
Schedule IDRequired | choice |
| Employee ID | number |
| Start Date Time | date |
| End Date Time | date |
| Position | text |
| Is Open | boolean |
| Is Available | boolean |
| Is Published | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee ID | number |
| Start date time | date |
| End date time | date |
| Position name | text |
| Department name | text |
| Is time sheet linked | boolean |
| Is deleted | boolean |
| Notes | text |
Get SchedulesSearch
Input fields[3]
| Field | Type |
|---|---|
| Is Archived | boolean |
| Include Unpublished | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| English name | text |
| French name | text |
| Created date | date |
| Earliest shift date | text |
| Published up to date | text |
| Last published date | text |
| Owner | text |
| Is archived | boolean |
| Is deleted | boolean |
| Available shifts enabled | boolean |
| Available shifts position restriction enabled | boolean |
| Available shifts auto approval enabled | boolean |
| Drop shifts enabled | boolean |
| Drop shifts auto approval enabled | boolean |
| Drop threshold minutes | number |
| Exceptions | object |
| Pay groups | array |
| Departments | array |
| Positions | array |
| Employees | array |
Get Timeoff RequestsSearch
Get TimeSheetsSearch
Input fields[3]
| Field | Type |
|---|---|
| Timesheet ID | choice |
| Employee ID | number |
| Start Date Time | date |
| End Date Time | date |
| Exception Department | text |
| Exception Cost Centre | text |
| Position | text |
| Hours Worked | number |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee ID | number |
| Earning description | text |
| Start date time | date |
| End date time | date |
| Hours | number |
| Exception department | text |
| Exception cost centre | text |
| Exception rate | number |
| Status | text |
| Changed by | text |
| Saved date | date |
| Schedule ID | number |
| Position | text |
Add Employee EarningAction
Create a ScheduleAction
Input fields[3]
| Field | Type |
|---|---|
Publish Notification OptionRequired | choice |
ExceptionsRequired | object |
| Pay Groups | array |
| Departments | array |
| Positions | array |
| Employees | array |
| English Name | text |
| French Name | text |
| Published Up To Date | date |
| Available Shifts Enabled | boolean |
| Shifts Position Restriction Enabled | boolean |
| Available Shifts Auto Approval Enabled | boolean |
| Drop Shifts Enabled | boolean |
| Drop Shifts Auto Approval Enabled | boolean |
| Drop Threshold Minutes | number |
Output fields[3]
| Field | Type |
|---|---|
| Schedule ID | number |
Create a TimesheetAction
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | number |
Start DateTimeRequired | date |
End DateTimeRequired | date |
StatusRequired | choice |
| Earning Description | text |
| Hours | number |
| Exception Department | text |
| Exception Cost Centre | text |
| Exception Rate | number |
| Is Override Rate | boolean |
| Position | text |
| Use Rounding Rules | boolean |
| Manager Note | text |
| Employee Note | text |
Output fields[3]
| Field | Type |
|---|---|
| Employee ID | number |
| Employee number | text |
| Start date time | text |
| End date time | text |
| Earnings description | text |
| Hours | number |
| Exception department | text |
| Exception cost centre | text |
| Exception rate | number |
| Status | text |
| Position | text |
| Manager note | text |
| Employee note | text |
Create an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
EmployeeRequired | object |
| Employee Number | text |
| Salutation | text |
First NameRequired | text |
| Middle Name | text |
| Preferred Name | text |
Last NameRequired | text |
| Preferred Last Name | text |
| Employment Type Option | choice |
| Payroll Status | object |
Employee ContactRequired | object |
| Primary Address | text |
| Secondary Address | text |
| Primary City | text |
| Secondary City | text |
| Primary Postal Code | text |
| Secondary Postal Code | text |
Primary ProvinceRequired | text |
| Secondary Province | text |
| Work Email Address | |
| Personal Email Address | |
Employee DatesRequired | object |
Start DateRequired | date |
| Termination Date | date |
| Seniority Date | date |
Insurable DateRequired | date |
Employee OrganizationRequired | object |
Business NumberRequired | object |
| Provincial Business Number | text |
Pay GroupRequired | text |
Employee PersonalRequired | object |
| Citizenship | text |
Language PreferenceRequired | text |
Employee Phone NumberRequired | object |
| Office Phone | text |
| Home Phone | text |
| Cell Phone | text |
| Fax | text |
| Pager | text |
Employee SensitiveRequired | object |
Birth DateRequired | date |
| Gender | choice |
| Gender Code | choice |
Employee SINRequired | object |
| Social Insurance Number | text |
| Work Permit Number | text |
| Work Permit Expiry | date |
Employee TaxRequired | object |
Tax ProvinceRequired | text |
| Federal Personal Tax Exemption | number |
| Provincial Personal Tax Exemption | number |
| Additional Tax | number |
| Additional Provincial Tax | number |
| Annual Exempt Expenses | number |
| Annual Provincial Exempt Expenses | number |
| Authorized Federal Tax Credit | number |
| Authorized Provincial Tax Credit | number |
| TD1X Estimated Annual Income for Commission | number |
EmploymentRequired | object |
Primary EarningRequired | object |
| Occupation | text |
Hours Per PayRequired | number |
| Contract Business Number | number |
| Security Level | number |
| Home Cost Centre | object |
| Home Department | text |
| Employee Rate | object |
Pay DescriptionRequired | text |
Pay RateRequired | number |
| Rate Change Comments | text |
| Rate Change History Date | date |
| Rate Change Type | text |
| Schedule | text |
| Future Change Type | text |
| Rate Effective Date | date |
| Part Time | boolean |
| Part Time Percent | number |
Output fields[3]
| Field | Type |
|---|---|
| Employee ID | number |
| Employee number | text |
Create Payroll EntriesAction
Input fields[3]
| Field | Type |
|---|---|
Payroll EntriesRequired | array |
Employee IDRequired | number |
Pay Element TypeRequired | choice |
Pay Element DescriptionRequired | text |
AmountRequired | number |
| Employee Number | text |
| Department Name | text |
| Rate | number |
Make an API Calluniversal
Update a ScheduleAction
Input fields[3]
| Field | Type |
|---|---|
Schedule IDRequired | choice |
Publish Notification OptionRequired | choice |
ExceptionsRequired | object |
| Pay Groups | array |
| Departments | array |
| Positions | array |
| Employees | array |
| English Name | text |
| French Name | text |
| Published Up To Date | date |
| Available Shifts Enabled | boolean |
| Shifts Position Restriction Enabled | boolean |
| Available Shifts Auto Approval Enabled | boolean |
| Drop Shifts Enabled | boolean |
| Drop Shifts Auto Approval Enabled | boolean |
| Drop Threshold Minutes | number |
Update an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Employee | object |
| Employee Number | text |
| Salutation | text |
| First Name | text |
| Middle Name | text |
| Preferred Name | text |
| Last Name | text |
| Preferred Last Name | text |
| Employment Type Option | choice |
| Payroll Status | object |
| Employee Contact | object |
| Primary Address | text |
| Secondary Address | text |
| Primary City | text |
| Secondary City | text |
| Primary Postal Code | text |
| Secondary Postal Code | text |
| Primary Province | text |
| Secondary Province | text |
| Work Email Address | |
| Personal Email Address | |
| Employee Dates | object |
| Start Date | date |
| Termination Date | date |
| Seniority Date | date |
| Insurable Date | date |
| Employee Organization | object |
| Business Number | object |
| Provincial Business Number | text |
| Pay Group | text |
| Employee Personal | object |
| Citizenship | text |
| Language Preference | text |
| Employee Phone Number | object |
| Office Phone | text |
| Home Phone | text |
| Cell Phone | text |
| Fax | text |
| Pager | text |
| Employee Sensitive | object |
| Birth Date | date |
| Gender | choice |
| Gender Code | choice |
| Employee SIN | object |
| Social Insurance Number | text |
| Work Permit Number | text |
| Work Permit Expiry | date |
| Employee Tax | object |
| Tax Province | text |
| Federal Personal Tax Exemption | number |
| Provincial Personal Tax Exemption | number |
| Additional Tax | number |
| Additional Provincial Tax | number |
| Annual Exempt Expenses | number |
| Annual Provincial Exempt Expenses | number |
| Authorized Federal Tax Credit | number |
| Authorized Provincial Tax Credit | number |
| TD1X Estimated Annual Income for Commission | number |
| Employment | object |
| Primary Earning | object |
| Occupation | text |
| Hours Per Pay | number |
| Contract Business Number | number |
| Security Level | number |
| Home Cost Centre | object |
| Home Department | text |
| Employee Rate | object |
| Pay Description | text |
| Pay Rate | number |
| Rate Change Comments | text |
| Rate Change History Date | date |
| Rate Change Type | text |
| Schedule | text |
| Future Change Type | text |
| Rate Effective Date | date |
| Part Time | boolean |
| Part Time Percent | number |
Templates
Look for Payworks templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Beamery[2]Talent lifecycle CRM for recruiting, talent pooling, campaigns, and workforce planning.
- AladtecWorkforce scheduling and timekeeping for public safety and healthcare teams.
- AchieversEmployee recognition and engagement platform for celebrations, rewards, and newsfeeds.
- Breezy HRApplicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.
- BrightHRHR software for small businesses covering people, absence, and time tracking.
References
- WEXTL® Payworks Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Payworks.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12