> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Oyster HR

> How to set up the Oyster HR connector, plus the actions and events that are available.

![Oyster HR](https://stackone-logos.com/api/oyster/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/oysterhr/changelog.md)

[59 actions](#actions) · [45 events](#events) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/oysterhr/guides/connector-profile/oauth-2-0.md)
>
> Connect using OAuth 2.0 by creating a Developer App in the Oyster Developer Portal.

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/oysterhr/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Server-to-server access with no sign-in screen. Access to client credentials is restricted — request it from Oyster HR b...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/oysterhr/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/oysterhr/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

manage

read

subscribe

No scopes found

59 actions

ActionDescriptionRequired scopes

Get Company`oysterhr_get_company`

Retrieve company details for the authenticated organization

`read`

List Webhooks`oysterhr_list_webhooks`

Retrieve all webhook endpoints registered for the authenticated organization

`read`

List Webhook Dispatches`oysterhr_list_webhook_dispatches`

Retrieve all webhook dispatches for the authenticated Developer application

`subscribe`

Delete Webhook`oysterhr_delete_webhook`

Delete a webhook endpoint by ID

`subscribe`

List Departments`oysterhr_get_departments`

Retrieve a paginated list of departments

`read`

List Engagements`oysterhr_get_engagements`

Retrieve a paginated list of engagements (employees and contractors)

`read`

Get Engagement`oysterhr_get_engagement`

Retrieve details of a specific engagement by ID

`read`

List Engagement Allowances`oysterhr_get_engagement_allowances`

Retrieve a paginated list of allowances for a specific engagement

`read`

List Engagement Bonuses`oysterhr_get_engagement_bonuses`

Retrieve a paginated list of bonuses for a specific engagement

`read`

Update Personal Details`oysterhr_update_personal_details`

Update personal details for an employment

`manage`

List Engagement Documents`oysterhr_get_engagement_documents`

Retrieve a paginated list of documents for a specific engagement

`read`

List Engagement Payslips`oysterhr_get_engagement_payslips`

Retrieve a paginated list of payslips for a specific engagement

`read`

List Contract Changes`oysterhr_list_contract_changes`

Retrieve all contract change requests across engagements

`read`

Get Contract Change`oysterhr_get_contract_change`

Retrieve details for a specific contract change request

`read`

Create Contract Change`oysterhr_create_contract_change`

Create a new contract change request for an engagement

`manage`

Cancel Contract Change`oysterhr_cancel_contract_change`

Cancel a contract change request

`manage`

List Time Off Entitlements`oysterhr_get_time_off_entitlements`

Retrieve a paginated list of time off entitlements

`read`

Get Time Off Entitlement`oysterhr_get_time_off_entitlement`

Retrieve entitlements for an individual engagement

`read`

List Time Off Requests`oysterhr_get_time_off_requests`

Retrieve a paginated list of time off requests

`read`

Get Time Off Request`oysterhr_get_time_off_request`

Retrieve an individual time off request by ID

`read`

Create Time Off Request`oysterhr_create_time_off_request`

Create a new time off request for an engagement

`manage`

Approve Time Off Request`oysterhr_approve_time_off_request`

Approve a pending time off request

`manage`

Reject Time Off Request`oysterhr_reject_time_off_request`

Reject a pending time off request

`manage`

List Expenses`oysterhr_get_expenses`

Retrieve all expenses

`read`

Get Expense`oysterhr_get_expense`

Retrieve an individual expense by ID

`read`

Create Expense`oysterhr_create_expense`

Create a new expense record

`manage`

Delete Expense`oysterhr_delete_expense`

Delete an expense record by ID

`manage`

Approve Expense`oysterhr_approve_expense`

Approve a pending expense

`manage`

Decline Expense`oysterhr_decline_expense`

Decline a pending expense

`manage`

List Payroll`oysterhr_get_all_payroll`

Retrieve a paginated list of payroll entries

`read`

Get Payroll Item`oysterhr_get_individual_payroll`

Retrieve a single payroll entry by ID

`read`

List Payroll Records`oysterhr_get_payroll_records`

Retrieve payroll records for an individual payroll

`read`

List Payroll Changes`oysterhr_get_payroll_changes`

Retrieve all payroll changes

`read`

Get Payroll Change`oysterhr_get_payroll_change`

Retrieve a single payroll change by ID

`read`

Create Payroll Change`oysterhr_create_payroll_change`

Create a payroll change for an engagement

`read`

Update Payroll Change`oysterhr_update_payroll_change`

Update an existing payroll change

`manage`

Cancel Payroll Change`oysterhr_cancel_payroll_change`

Cancel a payroll change

`manage`

Get Default Payroll Changes Source Types`oysterhr_get_default_payroll_changes_source_types`

Retrieve default payroll changes rulesets for source types

`read`

Get Default Payroll Changes Ruleset`oysterhr_get_default_payroll_changes_ruleset`

Retrieve default payroll changes ruleset

`read`

Get Payroll Changes Source Types`oysterhr_get_payroll_changes_source_types`

Retrieve payroll changes rulesets for source types

`read`

Get Payroll Changes Ruleset`oysterhr_get_payroll_changes_ruleset`

Retrieve payroll changes ruleset

`read`

List Bank Accounts`oysterhr_get_bank_accounts`

Retrieve bank accounts for the company

`read`

Get Bank Account`oysterhr_get_bank_account`

Retrieve bank account details by ID

`read`

List Time Sheets`oysterhr_get_time_sheets`

Retrieve all time sheets for the company

`read`

Get Time Sheet`oysterhr_get_time_sheet`

Retrieve an individual time sheet by ID

`read`

Create Time Sheet`oysterhr_create_time_sheet`

Create a new time sheet for an engagement

`manage`

Create Time Sheet Entry`oysterhr_create_time_sheet_entry`

Create a new entry in a time sheet

`manage`

Submit Time Sheet`oysterhr_submit_time_sheet`

Submit a time sheet for approval

`manage`

Confirm Time Sheet`oysterhr_confirm_time_sheet`

Confirm a time sheet

`manage`

Update Time Sheet Entry`oysterhr_update_time_sheet_entry`

Update an existing time sheet entry

`manage`

Delete Time Sheet Entry`oysterhr_delete_time_sheet_entry`

Delete a time sheet entry

`manage`

Delete Time Sheet`oysterhr_delete_time_sheet`

Delete a time sheet

`manage`

Create Hiring Employment`oysterhr_create_hiring_employment`

Create a new hiring employment record

`manage`

Get Hiring Employment`oysterhr_get_hiring_employment`

Retrieve an individual hiring employment by ID

`read`

Submit Hiring Employment`oysterhr_submit_hiring_employment`

Submit a hiring employment for processing

`manage`

Invite Team Member`oysterhr_invite_team_member`

Send invitation to a team member for a hiring employment

`manage`

Get Hiring Employment Tasks`oysterhr_get_hiring_employment_tasks`

Retrieve hiring process tasks for an employment

`read`

Update Hiring Employment`oysterhr_update_hiring_employment`

Update a draft hiring employment record

`manage`

Delete Hiring Employment`oysterhr_delete_hiring_employment`

Delete a draft hiring employment record

`manage`

## Events

Tags

Select all
|
Clear

Agreements

Charges

Contract Changes

Contractors

Documents

Employments

Engagements

Expenses

Invitations

Offboarding

Payments

Payslips

Tasks

Team Members

Time Off

Time Sheets

Webhooks

No tags found

45 events

EventDescriptionTags

Hiring Agreement Accepted`oysterhr_webhook_hiring_agreement_accepted`

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

AgreementsWebhooks

Hiring Agreement Drafted`oysterhr_webhook_hiring_agreement_drafted`

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

AgreementsWebhooks

Hiring Agreement Signed`oysterhr_webhook_hiring_agreement_signed`

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

AgreementsWebhooks

Hiring Agreement Updated`oysterhr_webhook_hiring_agreement_updated`

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

AgreementsWebhooks

Hiring Agreement Verified`oysterhr_webhook_hiring_agreement_verified`

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

AgreementsWebhooks

Hiring Contractor Engaged`oysterhr_webhook_hiring_contractor_engaged`

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

ContractorsWebhooks

Hiring Contractor Submitted`oysterhr_webhook_hiring_contractor_submitted`

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

ContractorsWebhooks

Hiring Employment Engaged`oysterhr_webhook_hiring_employment_engaged`

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

EmploymentsWebhooks

Hiring Employment Onboarding Completed`oysterhr_webhook_hiring_employment_onboarding_completed`

Emitted when a new employee completes all onboarding steps and requirements. Maps to OysterHR event \`hiring.employment\_o...

EmploymentsWebhooks

Hiring Employment Submitted`oysterhr_webhook_hiring_employment_submitted`

Emitted when a new employee hiring request is submitted for processing. Maps to OysterHR event \`hiring.employment\_submit...

EmploymentsWebhooks

Hiring Oyster Invitation Accepted`oysterhr_webhook_hiring_oyster_invitation_accepted`

Emitted when a team member accepts their invitation to join the Oyster platform. Maps to OysterHR event \`hiring.oyster\_i...

InvitationsWebhooks

Hiring Payroll Team Member Engaged`oysterhr_webhook_hiring_payroll_team_member_engaged`

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

Team MembersWebhooks

Hiring Payroll Team Member Submitted`oysterhr_webhook_hiring_payroll_team_member_submitted`

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

Team MembersWebhooks

Hiring Task Updated`oysterhr_webhook_hiring_task_updated`

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

TasksWebhooks

Offboarding Approved`oysterhr_webhook_offboarding_approved`

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

OffboardingWebhooks

Offboarding Cancelled`oysterhr_webhook_offboarding_cancelled`

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

OffboardingWebhooks

Offboarding Engagement Terminated`oysterhr_webhook_offboarding_engagement_terminated`

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

OffboardingWebhooks

Offboarding Initiated`oysterhr_webhook_offboarding_initiated`

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

OffboardingWebhooks

Time Off Request Created`oysterhr_webhook_time_off_request_created`

Emitted when a team member submits a new time off request for approval. Maps to OysterHR event \`time\_off.request\_created...

Time OffWebhooks

Time Off Request Modified`oysterhr_webhook_time_off_request_modified`

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

Time OffWebhooks

Time Off Request Status Changed`oysterhr_webhook_time_off_request_status_changed`

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

Time OffWebhooks

Time Tracking Time Sheet Approved`oysterhr_webhook_time_tracking_time_sheet_approved`

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

Time SheetsWebhooks

Time Tracking Time Sheet Created`oysterhr_webhook_time_tracking_time_sheet_created`

Emitted when a new time sheet is created for a team member's work period. Maps to OysterHR event \`time\_tracking.time\_she...

Time SheetsWebhooks

Time Tracking Time Sheet Deleted`oysterhr_webhook_time_tracking_time_sheet_deleted`

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

Time SheetsWebhooks

Time Tracking Time Sheet Entries Modified`oysterhr_webhook_time_tracking_time_sheet_entries_modified`

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

Time SheetsWebhooks

Time Tracking Time Sheet Pending Approval`oysterhr_webhook_time_tracking_time_sheet_pending_approval`

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

Time SheetsWebhooks

Time Tracking Time Sheet Submitted`oysterhr_webhook_time_tracking_time_sheet_submitted`

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

Time SheetsWebhooks

Engagements Document Uploaded`oysterhr_webhook_engagements_document_uploaded`

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

EngagementsDocumentsWebhooks

Engagements Document Updated`oysterhr_webhook_engagements_document_updated`

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

EngagementsDocumentsWebhooks

Engagements Document Deleted`oysterhr_webhook_engagements_document_deleted`

Emitted when a document is removed from a team member's engagement record. Maps to OysterHR event \`engagements.document\_...

EngagementsDocumentsWebhooks

Engagements Payslip Uploaded`oysterhr_webhook_engagements_payslip_uploaded`

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

EngagementsPayslipsWebhooks

Engagements Payslip Updated`oysterhr_webhook_engagements_payslip_updated`

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

EngagementsPayslipsWebhooks

Engagements Payslip Deleted`oysterhr_webhook_engagements_payslip_deleted`

Emitted when a payslip record is removed from a team member's engagement. Maps to OysterHR event \`engagements.payslip\_de...

EngagementsPayslipsWebhooks

Expenses Expense Approved`oysterhr_webhook_expenses_expense_approved`

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

ExpensesWebhooks

Expenses Expense Created`oysterhr_webhook_expenses_expense_created`

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

ExpensesWebhooks

Expenses Expense Declined`oysterhr_webhook_expenses_expense_declined`

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

ExpensesWebhooks

Contract Change Applied`oysterhr_webhook_contract_change_applied`

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

Contract ChangesWebhooks

Contract Change Approved`oysterhr_webhook_contract_change_approved`

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

Contract ChangesWebhooks

Contract Change Cancelled`oysterhr_webhook_contract_change_cancelled`

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

Contract ChangesWebhooks

Contract Change Requested`oysterhr_webhook_contract_change_requested`

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

Contract ChangesWebhooks

Contract Change Submitted`oysterhr_webhook_contract_change_submitted`

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

Contract ChangesWebhooks

Contract Change Updated`oysterhr_webhook_contract_change_updated`

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

Contract ChangesWebhooks

Payments Charge Paid`oysterhr_webhook_payments_charge_paid`

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

PaymentsChargesWebhooks

Payments Charge Failed`oysterhr_webhook_payments_charge_failed`

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

PaymentsChargesWebhooks

Payments Charge Group Paid`oysterhr_webhook_payments_charge_group_paid`

Emitted when a group of payment charges is successfully processed as a batch. Maps to OysterHR event \`payments.charge\_gr...

PaymentsChargesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.