About this integration
Payroll processing and compliance for Canadian employers. This integration exposes its full API as workflow modules.
The integration includes 5 triggers, 14 search modules and 8 actions. Connections use oauth or oauth or oauth or oauth or oauth authentication.
How to connect
The credential form asks for Client ID, Client Secret, Paywork Customer Number, and URL.
Prefer the interactive builder form? Open it on the app page.
Sign in and approve access — your password is never shared with WEXTL®, and you can revoke access from the provider at any time.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You can read how to get your Client Credentials from here: https://developer.payworks.ca/aeh/s/getting-started?language=en_CA
.You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You can read how to get your Client Credentials from here: https://developer.payworks.ca/aeh/s/getting-started?language=en_CA
.You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You can read how to get your Client Credentials from here: https://developer.payworks.ca/aeh/s/getting-started?language=en_CA
.You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You can read how to get your Client Credentials from here: https://developer.payworks.ca/aeh/s/getting-started?language=en_CA
.You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You can read how to get your Client Credentials from here: https://developer.payworks.ca/aeh/s/getting-started?language=en_CA
.Connecting Payworks to WEXTL®
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | — |
Client SecretRequired | password | — |
Paywork Customer NumberRequired | text | Paywork Customer Number associated to your Client Credentials |
URL | hidden | — |
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | — |
Client SecretRequired | password | — |
Paywork Customer NumberRequired | text | Paywork Customer Number associated to your Client Credentials |
URL | hidden | — |
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | — |
Client SecretRequired | password | — |
Paywork Customer NumberRequired | text | Paywork Customer Number associated to your Client Credentials |
URL | hidden | — |
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | — |
Client SecretRequired | password | — |
Paywork Customer NumberRequired | text | Paywork Customer Number associated to your Client Credentials |
URL | hidden | — |
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | — |
Client SecretRequired | password | — |
Paywork Customer NumberRequired | text | Paywork Customer Number associated to your Client Credentials |
URL | hidden | — |
Use it in workflow automation
Start with Watch Holidays, then add Add Employee Earning.
The canvas below runs Watch Holidays into Add Employee Earning — watch the video, then drop a node onto the canvas.
Select the Watch Schedules trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Add Employee Earning as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 13 ready-made modules for HR work — each run logs its inputs and outputs for debugging.
Payworks workflow on the canvas: Watch Schedules then Add Employee Earning
Triggers, searches and actions
Browse every Payworks module field below: 5 triggers, 14 searchs, and 8 actions you can drop onto the canvas.
Triggers
This integration includes 5 triggers — start a workflow the moment something changes in the app.
- Watch Holidays
- Watch Pay Periods
- Watch Schedules
- Watch Timeoff Requests
- Watch Timesheets
Searches
Use any of 14 search modules to retrieve records without leaving the workflow canvas.
- Create a Schedule Shift
- Get an Employee
- Get a Schedule
- Get a Schedule Shift
- Get Employees
Actions
This integration includes 8 action modules — create, update, or delete records as part of any workflow.
- Add Employee Earning
- Create an Employee
- Create a Schedule
- Create a Timesheet
- Create Payroll Entries
Explore the fields available for each Payworks trigger, search, and action.
Triggers
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Searches
| Field | Type |
|---|---|
Schedule IDRequired | choice |
Shifts | array |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
Employee IDRequired | choice |
| 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 |
| Field | Type |
|---|---|
Schedule IDRequired | choice |
| 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 |
| Field | Type |
|---|---|
Schedule IDRequired | choice |
| 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 |
| 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 |
| 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 |
| Field | Type |
|---|---|
Start Date | date |
End Date | date |
Is Observed | boolean |
Limit | number |
| 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 |
| Field | Type |
|---|---|
Schedule IDRequired | number |
| 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 |
| Field | Type |
|---|---|
Pay Group Name | text |
Year | number |
Run Type | choice |
Payment Date | date |
Pay Period Number | number |
Pay Processing Date | date |
Limit | number |
| 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 |
| Field | Type |
|---|---|
Schedule IDRequired | number |
Employee ID | number |
Employee Number | text |
Limit | number |
| Field | Type |
|---|---|
Statement | object |
Sequence number | text |
Payment type | object |
Company | object |
Employee | object |
Balance | array |
Earning | array |
Deduction | array |
Summary | object |
| Field | Type |
|---|---|
Schedule IDRequired | number |
Employee ID | number |
Employee Number | text |
Limit | number |
| Field | Type |
|---|---|
Statement | object |
Sequence number | text |
Payment type | object |
Company | object |
Employee | object |
Balance | array |
Earning | array |
Deduction | array |
Summary | object |
| Field | Type |
|---|---|
Is Archived | boolean |
Include Unpublished | boolean |
Limit | number |
| 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 |
| 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 |
| 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 |
| Field | Type |
|---|---|
Start Date | date |
End Date | date |
Status | choice |
Limit | number |
| 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 |
| 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 |
| 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 |
Actions
| Field | Type |
|---|---|
Employee IDRequired | choice |
Earning RateRequired | number |
Earning DescriptionRequired | text |
Province NameRequired | text |
Business NumberRequired | text |
Effective Date | date |
Second Factor | text |
Remaining Target | text |
| Field | Type |
|---|---|
Employee ID | number |
| 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 |
| Field | Type |
|---|---|
Employee ID | number |
Employee number | text |
| 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 |
| Field | Type |
|---|---|
Schedule ID | number |
| 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 |
| 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 |
| 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 |
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| 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 |
| 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 |



