Oyster

Global employment platform for hiring, payroll, contractors, and compliance worldwide.

1 trigger23 searches25 actionsInstant (webhooks)Auth: OAuth

AI-assisted documentation25 min read

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

Open Oyster on WEXTL →

Requirements

Connecting Oyster takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]

Get your Oyster credentials

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

Client IDtextRequired
Use the following instruction to generate credentials: https://docs.oysterhr.com/docs/customer-guide-to-creating-and-authorizing-a-developer-application.
[1]
Client SecretpasswordRequired

Connect Oyster in WEXTL

Log in to your WEXTL account, add the Oyster node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Oyster 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 →

Connecting Oyster to WEXTL® — Video slide demonstrates how to integrate Oyster in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Oyster in the WEXTL visual workflow builder.[4]

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 →

Oyster node modules

The list below is a reference of every Oyster node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any Oyster node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch EventsTrigger

Output fields[3]

Field	Type
User ID	number
Email address	email
Name	text
Date created	date

Get a Bank AccountAction

Input fields[3]

Field	Type
Bank Account IDRequired	choice

Output fields[3]

Field	Type
Engagement ID	text
Bank account ID	text
Payout usage	text
Is primary	boolean
Currency code	text
Country code	text
Details	object
Account number	text
Iban	text
Swift bic code	text
Branch code	text
Bank code	text
Recipient city	text
Recipient street	text
Recipient country	text
Recipient zip post code	text
Recipient state or province	text

Get a ChargeAction

Input fields[3]

Field	Type
Charge Group IDRequired	choice

Output fields[3]

Field	Type
ID	text
Status	text
Amount	object
Decimal	text
Currency code	text
Amount due	object
Decimal	text
Currency code	text
Completed at	date
Collection type	text
Subject	object
ID	text
Type	text

Get a Charge GroupAction

Input fields[3]

Field	Type
Charge Group IDRequired	choice

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

Get a Country Onboarding FormAction

Input fields[3]

Field	Type
Country CodeRequired	text

Output fields[3]

Field	Type
Sections	array
State	text

Get a Credit NoteAction

Input fields[3]

Field	Type
Credit Note IDRequired	choice

Output fields[3]

Field	Type
ID	text
Reference code	text
Type	text
Status	text
Payroll month	text
Payroll year	text
Issue date	date
Total amount	object
Decimal	text
Currency code	text
Amount remaining	object
Decimal	text
Currency code	text
Files	object
Document	object
Applied to invoices	array

Get a Document from the Onboarding FormAction

Input fields[3]

Field	Type
Employment IDRequired	number
Field ID or Document IDRequired	text

Output fields[3]

Field	Type
ID	text
Title	text
Description	text
URL	text
Content type	text

Get a PayoutAction

Input fields[3]

Field	Type
Payout IDRequired	text

Output fields[3]

Field	Type
ID	text
Status	text
Amount	object
Decimal	text
Currency code	text
Status changes	array
Subject	object
ID	text
Type	text

Get an Employment Onboarding FormAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Sections	array
State	text

Get an Individual EmploymentAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
User ID	number
Email address	email
Name	text

Get an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice

Output fields[3]

Field	Type
ID	text
Reference code	text
Type	text
Status	text
Payroll month	text
Payroll year	text
Issue date	date
Due date	date
Amount	object
Decimal	text
Currency code	text
Tax percentage	text
Tax amount	object
Decimal	text
Currency code	text
Files	object
Document	object
Breakdown	object
Line items	array
Applied credit	array
Charge	object
ID	text
Status	text
Amount	object
Amount due	object
Payout	text

Get an OffboardingAction

Input fields[3]

Field	Type
Offboarding IDRequired	choice

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

Get PayrollAction

Input fields[3]

Field	Type
Payroll IDRequired	choice

Output fields[3]

Field	Type
ID	text
Payroll ID	text
Currency code	text
Cutoff time for payroll	date
State	text
Payroll records count	number
Records	array

List Bank AccountsSearch

Input fields[3]

Field	Type
Engagement ID	text
Limit	number

Output fields[3]

Field	Type
Engagement ID	text
Bank account ID	text
Payout usage	text
Is primary	boolean
Currency code	text
Country code	text
Details	object
Account number	text
Iban	text
Swift bic code	text
Branch code	text
Bank code	text
Recipient city	text
Recipient street	text
Recipient country	text
Recipient zip post code	text
Recipient state or province	text

List Charge Group ChargesSearch

Input fields[3]

Field	Type
Charge Group IDRequired	choice

Output fields[3]

Field	Type
ID	text
Status	text
Amount	object
Decimal	text
Currency code	text
Amount due	object
Decimal	text
Currency code	text
Completed at	text
Collection type	text
Subject	object
ID	text
Type	text

List Charge GroupsSearch

Input fields[3]

Field	Type
Search Query	text
Limit	number

Output fields[3]

Field	Type
ID	text
Reference code	text
Items count	number
State	text
Amount	object
Decimal	text
Currency code	text
Created at	date
Wire sent at	date
Paid at	date

List Credit NotesSearch

Input fields[3]

Field	Type
Reference Code	array
Reference Code	text
Payroll Period From	date
Payroll Period To	date
From Issue Date	date
To Issue Date	date
Types	choice
Statuses	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Reference code	text
Type	text
Status	text
Payroll month	text
Payroll year	text
Issue date	date
Total amount	object
Decimal	text
Currency code	text
Amount remaining	object
Decimal	text
Currency code	text

List Hiring Process TasksSearch

Input fields[3]

Field	Type
Employment IDRequired	number
Limit	number

Output fields[3]

Field	Type
Type	text
State	text
Visible to	array
Parties	array

List Invoice BreakdownsSearch

Input fields[3]

Field	Type
Invoice IDRequired	choice

Output fields[3]

Field	Type
Engagement ID	text
Engagement name	text
Region	text
Start date	date
Termination date	date
Service month	text
Cutoff date	date
Fx rate	object
From	text
To	text
Rate	text
Total	object
Decimal	text
Currency code	text
Components	array

List InvoicesSearch

Input fields[3]

Field	Type
Reference Codes	array
Reference Code	text
Payroll Period From	date
Payroll Period To	date
Issue Date From	date
Issue Date To	date
Types	choice
Statuses	choice
Engagement IDs	array
Engagement ID	text
Customer IDs	array
Customer ID	text
Charge Statuses	choice
Payout Statuses	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Reference code	text
Type	text
Status	text
Payroll month	text
Payroll year	text
Issue date	date
Due date	date
Amount	object
Decimal	text
Currency code	text
Charge	object
ID	text
Status	text
Amount	object
Amount due	object
Payout	object
ID	text
Status	text
Amount	object

List Offboarding AgreementsSearch

Input fields[3]

Field	Type
Offboarding IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Type	text
State	text

List OffboardingsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

List Payroll RecordsSearch

Input fields[3]

Field	Type
Payroll IDRequired	choice

Output fields[3]

Field	Type
ID	text
Engagement ID	text
Currency code	text
Monthly payments total amount	object
Decimal	text
Currency code	text
Allowances total amount	object
Decimal	text
Currency code	text
Benefits total amount	object
Decimal	text
Currency code	text
Bonuses total amount	object
Decimal	text
Currency code	text
Add ons total amount	object
Decimal	text
Currency code	text
Taxes total amount	object
Decimal	text
Currency code	text
True ups total amount	object
Decimal	text
Currency code	text
Oyster fees total amount	object
Decimal	text
Currency code	text
Engagement	object
Name	text
Cutoff month day	number
Type	text
Engagement type	text

List PayrollsSearch

Input fields[3]

Field	Type
From	text
To	text
Limit	number

Output fields[3]

Field	Type
ID	text
Payroll ID	text
Currency code	text
Cutoff time for payroll	date
State	text
Payroll records count	number

Approve an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice

Attach a Document to OffboardingAction

Input fields[3]

Field	Type
Offboarding IDRequired	choice
FileRequired	text
TitleRequired	text
DescriptionRequired	text

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

Confirm Wire SentAction

Input fields[3]

Field	Type
Charge Group IDRequired	choice
Wire Sent AtRequired	date

Output fields[3]

Field	Type
ID	text
Reference code	text
Items count	number
State	text
Amount	object
Decimal	text
Currency code	text
Created at	date
Wire sent at	date
Paid at	date

Create a Bank AccountAction

Input fields[3]

Field	Type
Engagement IDRequired	text
Is PrimaryRequired	boolean
Currency CodeRequired	text
Country CodeRequired	text
DetailsRequired	array
KeyRequired	text
Value	text
Use for Expenses	boolean
Ruleset ID	text

Output fields[3]

Field	Type
Engagement ID	text
Bank account ID	text
Payout usage	text
Is primary	boolean
Currency code	text
Country code	text
Details	object
Account number	text
Iban	text
Swift bic code	text
Branch code	text
Bank code	text
Recipient city	text
Recipient street	text
Recipient country	text
Recipient zip post code	text
Recipient state or province	text

Create EmploymentAction

Input fields[3]

Field	Type
Country CodeRequired	text
Personal DetailsRequired	object
Full Legal NameRequired	text
EmailRequired	email
NationalityRequired	text
Subdivision Code	text

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Delete a Bank AccountAction

Input fields[3]

Field	Type
Bank Account IDRequired	choice

Delete an EmploymentAction

Input fields[3]

Field	Type
Employment IDRequired	number

Delete an Employment Commission PlanAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Delete an Employment DocumentAction

Input fields[3]

Field	Type
Employment IDRequired	number
Document IDRequired	text

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Delete an Employment Work PermitAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Dispute an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
ReasonRequired	text

Initiate an OffboardingAction

Input fields[3]

Field	Type
Offboarding IDRequired	choice

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

Invite a Team MemberAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Mark an Onboarding Form as CompleteAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Sections	array
State	text

Request Cancellation for an Initiated OffboardingAction

Input fields[3]

Field	Type
Offboarding IDRequired	choice
Cancellation ReasonRequired	text

Output fields[3]

Field	Type
ID	text
Engagement	object
ID	text
Name	text
Country code	text
Start date	text
Probation end on	text
State	text
Initiated at	date
Cancelled at	text
Cancel reason	text
Requestor ID	text
Requestor	object
ID	text
Name	text
Email	text
Category	text
Last day on	text
Last working day on	text
Estimated payroll month	text
Pto	object
Intended pto	text
Pto days remaining	text
Reported pto taken	text
Pto inaccurate note	text
Mutual termination	text
Notes	text
Roe code	text
Additional payments	text
Proposed offboarding date	text
Reason	text
Early offboarding requested	text

7other output fields

Revoke Wire Sent ConfirmationAction

Input fields[3]

Field	Type
Charge Group IDRequired	choice

Output fields[3]

Field	Type
ID	text
Reference code	text
Items count	number
State	text
Amount	object
Decimal	text
Currency code	text
Created at	date
Wire sent at	date
Paid at	date

Submit an EmploymentAction

Input fields[3]

Field	Type
Employment IDRequired	number

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Update a Bank AccountAction

Input fields[3]

Field	Type
Bank Account IDRequired	choice
Is Primary	boolean
Use for Expenses	boolean
Alternative Bank Account ID	text

Output fields[3]

Field	Type
Engagement ID	text
Bank account ID	text
Payout usage	text
Is primary	boolean
Currency code	text
Country code	text
Details	object
Account number	text
Iban	text
Swift bic code	text
Branch code	text
Bank code	text
Recipient city	text
Recipient street	text
Recipient country	text
Recipient zip post code	text
Recipient state or province	text

Update an Employment Onboarding FormAction

Input fields[3]

Field	Type
Employment IDRequired	number
FieldsRequired	array

Output fields[3]

Field	Type
Sections	array
State	text

Update EmploymentAction

Input fields[3]

Field	Type
Employment IDRequired	number
Manager	object
Manager Role	text
Manager Name	text
Manager Email Address	email
Manager Phone Number	text
Manager is Expense Approver	boolean
Role	object
Seniority Level	choice
Role Type ID	text
Role	text
Job Description	text
Start Date	date
End Date	date
Employment Type	choice
Full Time Hours Per Week	number
Part Time Days Per Week	number
Part Time Hours Per Day	number
Personal Details	object
Full Legal Name	text
Email	email
Nationality	text
Compensation	object
Salary	object
Paid Holiday Days	number
Bonuses	array
Allowances	array
Reimbursement Budgets	array
Remote Work Costs	object
Private Notes	text
Sick Pay	object
Commission Plan Offered	boolean
Signer	object
Full NameRequired	text
Job TitleRequired	text
EmailRequired	email
PhoneRequired	object

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Upload a Document to an Employment Onboarding FormAction

Input fields[3]

Field	Type
Employment IDRequired	number
Field IDRequired	text
FileRequired	text
TitleRequired	text
DescriptionRequired	text

Output fields[3]

Field	Type
Sections	array
State	text

Upload an Employment Commission PlanAction

Input fields[3]

Field	Type
Employment IDRequired	number
FileRequired	text

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Upload an Employment DocumentAction

Input fields[3]

Field	Type
Employment IDRequired	number
FileRequired	text
TitleRequired	text
DescriptionRequired	text

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Upload an Employment Work PermitAction

Input fields[3]

Field	Type
Employment IDRequired	number
FileRequired	text

Output fields[3]

Field	Type
Engagement ID	text
Country code	text
Subdivision code	text
Status	text
Personal details	object
Full legal name	text
Email	text
Nationality	text
Work permit	text
Manager	object
Manager role	text
Manager name	text
Manager email address	text
Manager phone number	text
Manager is expense approver	boolean
Role	object
New hire status	text
Seniority level	text
Role type ID	text
Role	text
Job description	text
Start date	text
End date	text
Employment type	text
Probation period	text
Termination notice	text
Compensation	object
Commission plan offered	text
Commission plan	text
Salary	object
Paid holiday days	text
Bonuses	array
Allowances	array
Reimbursement budgets	array
Remote work costs	text
Private notes	text
Sick pay	text
Documents	array
Signer	text
Invitation	text

Templates

Look for Oyster templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

WEXTL® Oyster Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Oyster.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.