Requirements
Before you set up the credential, make sure you have an active Workstream account and OAuth client credentials, granted by signing in with your account ready.[3]
Get your Workstream credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
This can be retrieved from the Dashboard under Company -> Integrations -> Access Tokens.
[1] - Client SecretpasswordRequired
This can be retrieved from the Dashboard under Company -> Integrations -> Access Tokens.
[1] - Access Token NametextRequired
Name of the access token displayed in the Dashboard.
[1]
Integration requests 9 permissions:
positionscompany_userscompany_rolesposition_applicationsemployeeslocationsdepartmentsteam_membersimported_employee_infos
Connect Workstream in WEXTL
- Log in to your WEXTL account, add the Workstream 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 Workstream 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 →
Workstream node modules
The list below is a reference of every Workstream node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Workstream node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch ApplicantsTrigger
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Digest key | text |
| Referer source | text |
| text | |
| Phone | text |
| First name | text |
| Last name | text |
| Name | text |
| Status | text |
| Global phone number | text |
| Sms notification | boolean |
| Current stage | text |
| Hired at | date |
| Application date | date |
| Latest interview date | date |
| Position | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| Name | text |
| Description | text |
| Notes | array |
| Tags | array |
2other output fields
Watch Company UsersTrigger
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Name | text |
| Status | text |
| Region number | text |
| Phone | text |
| Created at | date |
| User | object |
| text | |
| UUID | text |
| Created at | date |
| Company role | object |
| UUID | text |
| Name | text |
| Editable | boolean |
| Permissions set | array |
| Created at | date |
| Permission config | object |
| All locations | boolean |
| Locations | array |
Watch EmployeesTrigger
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Start date | date |
| Applied date | date |
| Hired date | date |
| Onboard date | date |
| Status | text |
| Information | object |
| Phone | text |
| text | |
| Birthday | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Emergency contact | object |
| Name | text |
| text | |
| Phone | text |
| Relationship | text |
| Employment details | object |
| Applied date | text |
| Department name | text |
| Hired date | text |
| Job title | text |
| Manager | text |
| Start date | text |
| Work location | object |
| Name | text |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Compensation | object |
| Additional remuneration | text |
| Additional remuneration currency code | text |
| Employment status | text |
| Status | text |
| Wage amount | text |
| Wage currency code | text |
| Wage pay frequency | text |
| Direct deposits | array |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Dependents | number |
| Two jobs | boolean |
| Exempt from withholding | text |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Eligibility | object |
| Admission number | text |
| Alien authorized to work expiration date | text |
| Alien registration or uscis number | text |
| Country of issuance | text |
| Lawful permanent resident alien registration or uscis number | number |
| Passport number | text |
| Resident status code | text |
| Social security number | text |
| Eligibility details | object |
| I 9 section one | object |
| I 9 section two | object |
4other output fields
Watch Team MembersTrigger
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Termination note | text |
| Start date | date |
| Status | text |
| Job title | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| UUID | text |
| Name | text |
| Information | object |
| Phone | text |
| text | |
| Dob | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Direct deposits | array |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Two jobs | boolean |
| Eligibility | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| Custom fields | array |
Get a DepartmentAction
Get a LocationAction
Get a PositionAction
Input fields[3]
| Field | Type |
|---|---|
Position IDRequired | choice |
| Embed | choice |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Digest key | text |
| Title | text |
| Overview | text |
| Status | text |
| Number | text |
| Access | text |
| Pay amount | text |
| Pay frequency | text |
| Job type | text |
| Normalized titles | text |
| Remote type | text |
| Job URL | text |
| Location | object |
| UUID | text |
| Name | text |
| Address | text |
| Postal code | text |
| City | text |
| State | text |
| Country | text |
| Custom fields | array |
Get a Team MemberAction
Input fields[3]
| Field | Type |
|---|---|
Team Member IDRequired | choice |
| Embed Resources | choice |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Termination note | text |
| Start date | date |
| Status | text |
| Job title | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| UUID | text |
| Name | text |
| Information | object |
| Phone | text |
| text | |
| Dob | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Direct deposits | array |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Two jobs | boolean |
| Eligibility | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| Custom fields | array |
Get an ApplicantAction
Input fields[3]
| Field | Type |
|---|---|
Applicant IDRequired | choice |
| Embed | choice |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Digest key | text |
| Referer source | text |
| text | |
| Phone | text |
| First name | text |
| Last name | text |
| Name | text |
| Status | text |
| Global phone number | text |
| Sms notification | boolean |
| Current stage | text |
| Hired at | date |
| Application date | date |
| Latest interview date | date |
| Position | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| Name | text |
| Description | text |
| Notes | array |
| Tags | array |
2other output fields
Get an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Embed Resources | choice |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Start date | date |
| Applied date | date |
| Hired date | date |
| Onboard date | date |
| Status | text |
| Information | object |
| Phone | text |
| text | |
| Birthday | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Emergency contact | object |
| Name | text |
| text | |
| Phone | text |
| Relationship | text |
| Employment details | object |
| Applied date | text |
| Department name | text |
| Hired date | text |
| Job title | text |
| Manager | text |
| Start date | text |
| Work location | object |
| Name | text |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Compensation | object |
| Additional remuneration | text |
| Additional remuneration currency code | text |
| Employment status | text |
| Status | text |
| Wage amount | text |
| Wage currency code | text |
| Wage pay frequency | text |
| Direct deposits | array |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Dependents | number |
| Two jobs | boolean |
| Exempt from withholding | text |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Eligibility | object |
| Admission number | text |
| Alien authorized to work expiration date | text |
| Alien registration or uscis number | text |
| Country of issuance | text |
| Lawful permanent resident alien registration or uscis number | number |
| Passport number | text |
| Resident status code | text |
| Social security number | text |
| Eligibility details | object |
| I 9 section one | object |
| I 9 section two | object |
4other output fields
List Applicant Custom FormsSearch
List ApplicantsSearch
Input fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Embed | choice |
| First Name | text |
| Last Name | text |
| Name | text |
| Current Stage | text |
| Position UUID | choice |
| Location Name | text |
| Tag Name | text |
| Note Content | text |
| Created At (Greater Than or Equal) | date |
| Created At (Less Than or Equal) | date |
| Hired At (Greater Than or Equal) | date |
| Hired At (Less Than or Equal) | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Digest key | text |
| Referer source | text |
| text | |
| Phone | text |
| First name | text |
| Last name | text |
| Name | text |
| Status | text |
| Global phone number | text |
| Sms notification | boolean |
| Current stage | text |
| Hired at | date |
| Application date | date |
| Latest interview date | date |
| Position | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| Name | text |
| Description | text |
| Notes | array |
| Tags | array |
2other output fields
List Company UsersSearch
Input fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Company User UUID | choice |
| Name | text |
| Created At Greater Than Or Equal | date |
| Created At Less Than Or Equal | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Name | text |
| Status | text |
| Region number | text |
| Phone | text |
| Created at | date |
| User | object |
| text | |
| UUID | text |
| Created at | date |
| Company role | object |
| UUID | text |
| Name | text |
| Editable | boolean |
| Permissions set | array |
| Created at | date |
| Permission config | object |
| All locations | boolean |
| Locations | array |
List DepartmentsSearch
List Employee DocumentsSearch
Input fields[3]
| Field | Type |
|---|---|
| Employee UUID | choice |
| First Name | text |
| Last Name | text |
| Onboarding Status | choice |
| Start Date After or Equal To | date |
| Start Date Before or Equal To | date |
| Hired Date After or Equal To | date |
| Hired Date Before or Equal To | date |
| Applied Date After or Equal To | date |
| Applied Date Before or Equal To | date |
| Onboard Date After or Equal To | date |
| Onboard Date Before or Equal To | date |
| Embed | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| URL | text |
| Type | text |
| Created at | date |
List EmployeesSearch
Input fields[3]
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| Onboarding Status | choice |
| Start Date Greater Than or Equal | date |
| Start Date Less Than or Equal | date |
| Hired Date Greater Than or Equal | date |
| Hired Date Less Than or Equal | date |
| Applied Date Greater Than or Equal | date |
| Applied Date Less Than or Equal | date |
| Onboard Date Greater Than or Equal | date |
| Onboard Date Less Than or Equal | date |
| Embed Resources | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Start date | date |
| Applied date | date |
| Hired date | date |
| Onboard date | date |
| Status | text |
| Information | object |
| Phone | text |
| text | |
| Birthday | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Emergency contact | object |
| Name | text |
| text | |
| Phone | text |
| Relationship | text |
| Employment details | object |
| Applied date | text |
| Department name | text |
| Hired date | text |
| Job title | text |
| Manager | text |
| Start date | text |
| Work location | object |
| Name | text |
| Address | text |
| City | text |
| State | text |
| Country | text |
| Zipcode | text |
| Compensation | object |
| Additional remuneration | text |
| Additional remuneration currency code | text |
| Employment status | text |
| Status | text |
| Wage amount | text |
| Wage currency code | text |
| Wage pay frequency | text |
| Direct deposits | array |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Dependents | number |
| Two jobs | boolean |
| Exempt from withholding | text |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Eligibility | object |
| Admission number | text |
| Alien authorized to work expiration date | text |
| Alien registration or uscis number | text |
| Country of issuance | text |
| Lawful permanent resident alien registration or uscis number | number |
| Passport number | text |
| Resident status code | text |
| Social security number | text |
| Eligibility details | object |
| I 9 section one | object |
| I 9 section two | object |
4other output fields
List Imported Employee InfosSearch
List LocationsSearch
List PositionsSearch
Input fields[3]
| Field | Type |
|---|---|
| Title | text |
| Status | choice |
| Access | choice |
| Location Name | text |
| Created At (Greater Than or Equal) | date |
| Created At (Less Than or Equal) | date |
| Embed | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Digest key | text |
| Title | text |
| Overview | text |
| Status | text |
| Number | text |
| Access | text |
| Pay amount | text |
| Pay frequency | text |
| Job type | text |
| Normalized titles | text |
| Remote type | text |
| Job URL | text |
| Location | object |
| UUID | text |
| Name | text |
| Address | text |
| Postal code | text |
| City | text |
| State | text |
| Country | text |
| Custom fields | array |
List Team MembersSearch
Input fields[3]
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| Status | choice |
| Location UUID | choice |
| Job Title | text |
| Start Date Greater Than or Equal | date |
| Start Date Less Than or Equal | date |
| Embed Resources | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| First name | text |
| Middle initial | text |
| Last name | text |
| Termination note | text |
| Start date | date |
| Status | text |
| Job title | object |
| UUID | text |
| Title | text |
| Location | object |
| UUID | text |
| Name | text |
| Department | object |
| UUID | text |
| Name | text |
| Information | object |
| Phone | text |
| text | |
| Dob | text |
| Ethnicity | text |
| Gender | text |
| Ssn | text |
| Marital status | text |
| Direct deposits | array |
| State tax | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| State | text |
| Tax form details | object |
| Federal tax | object |
| Deductions | number |
| Extra withholding | number |
| Filing status | text |
| Other income | number |
| Qualifying children num | number |
| Qualifying other num | number |
| Two jobs | boolean |
| Eligibility | object |
| Allowances exemptions | number |
| Extra withholding | number |
| Filing status | text |
| Tax form | text |
| Custom fields | array |
Create a Company UserAction
Input fields[3]
| Field | Type |
|---|---|
UserRequired | object |
EmailRequired | |
| Password | text |
Company User's Full NameRequired | text |
Company Role UUIDRequired | choice |
| Region Number | number |
| Company User's Phone Number | text |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Name | text |
| Status | text |
| Region number | text |
| Phone | text |
| Created at | date |
| User | object |
| text | |
| UUID | text |
| Created at | date |
| Company role | object |
| UUID | text |
| Name | text |
| Editable | boolean |
| Permissions set | array |
| Created at | date |
| Permission config | object |
| All locations | boolean |
| Locations | array |
Create a Team MemberAction
Input fields[3]
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
Date of BirthRequired | date |
Phone NumberRequired | text |
StatusRequired | choice |
Start DateRequired | date |
Work LocationRequired | object |
| Work Location ID | choice |
Job TitleRequired | object |
| Job Title ID | text |
DepartmentRequired | object |
| Department ID | choice |
Government IDsRequired | array |
| Middle Initial | text |
| Email Address | |
| Gender | choice |
| Metadata | array |
| Key | text |
| Value | text |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
Disable a Company UserAction
Download an Employee DocumentAction
Input fields[3]
| Field | Type |
|---|---|
Document IDRequired | text |
| Token | text |
Make an API Calluniversal
Update a Company UserAction
Input fields[3]
| Field | Type |
|---|---|
Company User IDRequired | choice |
| Company Role UUID | choice |
| Permission Config | object |
| All Locations | boolean |
| Locations | array |
Output fields[3]
| Field | Type |
|---|---|
| UUID | text |
| Name | text |
| Status | text |
| Region number | text |
| Phone | text |
| Created at | date |
| User | object |
| text | |
| UUID | text |
| Created at | date |
| Company role | object |
| UUID | text |
| Name | text |
| Editable | boolean |
| Permissions set | array |
| Created at | date |
| Permission config | object |
| All locations | boolean |
| Locations | array |
Templates
Look for Workstream templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Breezy HR[2]Applicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.
- AladtecWorkforce scheduling and timekeeping for public safety and healthcare teams.
- BullhornRecruiting ATS and CRM for staffing agencies and talent teams.
- BeameryTalent lifecycle CRM for recruiting, talent pooling, campaigns, and workforce planning.
- AchieversEmployee recognition and engagement platform for celebrations, rewards, and newsfeeds.
References
- WEXTL® Workstream Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Workstream.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:13