Oyster HR

Retrieve company details for the authenticated organization

Retrieve all webhook endpoints registered for the authenticated organization

Retrieve all webhook dispatches for the authenticated Developer application

Delete a webhook endpoint by ID

Retrieve a paginated list of departments

Retrieve a paginated list of engagements (employees and contractors)

Retrieve details of a specific engagement by ID

Retrieve a paginated list of allowances for a specific engagement

Retrieve a paginated list of bonuses for a specific engagement

Update personal details for an employment

Retrieve a paginated list of documents for a specific engagement

Retrieve a paginated list of payslips for a specific engagement

Retrieve all contract change requests across engagements

Retrieve details for a specific contract change request

Create a new contract change request for an engagement

Cancel a contract change request

Retrieve a paginated list of time off entitlements

Retrieve entitlements for an individual engagement

Retrieve a paginated list of time off requests

Retrieve an individual time off request by ID

Create a new time off request for an engagement

Approve a pending time off request

Reject a pending time off request

Retrieve all expenses

Retrieve an individual expense by ID

Create a new expense record

Delete an expense record by ID

Approve a pending expense

Decline a pending expense

Retrieve a paginated list of payroll entries

Retrieve a single payroll entry by ID

Retrieve payroll records for an individual payroll

Retrieve all payroll changes

Retrieve a single payroll change by ID

Create a payroll change for an engagement

Update an existing payroll change

Cancel a payroll change

Retrieve default payroll changes rulesets for source types

Retrieve default payroll changes ruleset

Retrieve payroll changes rulesets for source types

Retrieve payroll changes ruleset

Retrieve bank accounts for the company

Retrieve bank account details by ID

Retrieve all time sheets for the company

Retrieve an individual time sheet by ID

Create a new time sheet for an engagement

Create a new entry in a time sheet

Submit a time sheet for approval

Confirm a time sheet

Update an existing time sheet entry

Delete a time sheet entry

Delete a time sheet

Create a new hiring employment record

Retrieve an individual hiring employment by ID

Submit a hiring employment for processing

Send invitation to a team member for a hiring employment

Retrieve hiring process tasks for an employment

Update a draft hiring employment record

Delete a draft hiring employment record

Emitted when a team member accepts their employment or contractor agreement. Maps to OysterHR event `hiring.agreement_ac…

Emitted when a new employment or contractor agreement draft is created for review. Maps to OysterHR event `hiring.agreem…

Emitted when an employment or contractor agreement is fully signed by all parties. Maps to OysterHR event `hiring.agreem…

Emitted when an existing employment or contractor agreement is modified with new terms or details. Maps to OysterHR even…

Emitted when an employment or contractor agreement passes verification checks. Maps to OysterHR event `hiring.agreement_…

Emitted when a contractor engagement becomes active and the contractor is ready to begin work. Maps to OysterHR event `h…

Emitted when a new contractor hiring request is submitted for processing. Maps to OysterHR event `hiring.contractor_subm…

Emitted when an employee engagement becomes active and the employee officially starts their role. Maps to OysterHR event…

Emitted when a new employee completes all onboarding steps and requirements. Maps to OysterHR event `hiring.employment_o…

Emitted when a new employee hiring request is submitted for processing. Maps to OysterHR event `hiring.employment_submit…

Emitted when a team member accepts their invitation to join the Oyster platform. Maps to OysterHR event `hiring.oyster_i…

Emitted when a payroll team member engagement becomes active and payroll processing begins. Maps to OysterHR event `hiri…

Emitted when a new payroll team member hiring request is submitted for processing. Maps to OysterHR event `hiring.payrol…

Emitted when a hiring-related task is updated, such as a background check or document submission status change. Maps to…

Emitted when an offboarding request is approved and the termination process can proceed. Maps to OysterHR event `offboar…

Emitted when a previously initiated offboarding process is cancelled and the engagement continues. Maps to OysterHR even…

Emitted when an engagement is fully terminated and the team member is offboarded from the company. Maps to OysterHR even…

Emitted when an offboarding process is started for a team member, beginning the termination workflow. Maps to OysterHR e…

Emitted when a team member submits a new time off request for approval. Maps to OysterHR event `time_off.request_created…

Emitted when an existing time off request is modified, such as date or duration changes. Maps to OysterHR event `time_of…

Emitted when a time off request status changes, such as being approved, declined, or cancelled. Maps to OysterHR event `…

Emitted when a submitted time sheet is approved by a manager or administrator. Maps to OysterHR event `time_tracking.tim…

Emitted when a new time sheet is created for a team member’s work period. Maps to OysterHR event `time_tracking.time_she…

Emitted when a time sheet is deleted from the system. Maps to OysterHR event time_tracking.time_sheet_deleted.

Emitted when individual time entries within a time sheet are added, updated, or removed. Maps to OysterHR event `time_tr…

Emitted when a time sheet is submitted and awaiting manager or administrator approval. Maps to OysterHR event `time_trac…

Emitted when a team member submits their completed time sheet for the work period. Maps to OysterHR event `time_tracking…

Emitted when a new document is uploaded to a team member’s engagement record. Maps to OysterHR event `engagements.docume…

Emitted when an existing document on a team member’s engagement record is modified. Maps to OysterHR event `engagements…

Emitted when a document is removed from a team member’s engagement record. Maps to OysterHR event `engagements.document_…

Emitted when a new payslip is uploaded and made available for a team member. Maps to OysterHR event `engagements.payslip…

Emitted when an existing payslip record is modified or corrected. Maps to OysterHR event engagements.payslip_updated.

Emitted when a payslip record is removed from a team member’s engagement. Maps to OysterHR event `engagements.payslip_de…

Emitted when a submitted expense claim is approved for reimbursement. Maps to OysterHR event expenses.expense_approved…

Emitted when a team member submits a new expense claim for approval. Maps to OysterHR event expenses.expense_created.

Emitted when a submitted expense claim is declined and will not be reimbursed. Maps to OysterHR event `expenses.expense_…

Emitted when an approved contract change takes effect on the engagement terms. Maps to OysterHR event `contract.change_a…

Emitted when a requested contract change is approved and ready to be applied. Maps to OysterHR event `contract.change_ap…

Emitted when a pending contract change request is cancelled before being applied. Maps to OysterHR event `contract.chang…

Emitted when a change to an existing contract is requested, such as salary adjustment or role change. Maps to OysterHR e…

Emitted when a contract change request is formally submitted for review and approval. Maps to OysterHR event `contract.c…

Emitted when the details of a pending contract change request are modified before approval. Maps to OysterHR event `cont…

Emitted when a payment charge is successfully processed and funds are transferred. Maps to OysterHR event `payments.char…

Emitted when a payment charge fails to process due to insufficient funds or other payment issues. Maps to OysterHR event…

Emitted when a group of payment charges is successfully processed as a batch. Maps to OysterHR event `payments.charge_gr…