OysterHR HRIS Integration

This connector is in open beta. You can freely enable it in your account.

The OysterHR HRIS integration allows you to sync HRIS data between OysterHR and your application through Kombo’s unified API. The tool slug for this connector is oysterhr.

Guides and Resources

Connection Setup Guide

Step-by-step instructions to connect your OysterHR account to Kombo.

Supported Features & Coverage

Models
Actions
Features
Create Employee with Form

Legal Entities

Field	Notes
id
remote_id
changed_at
remote_deleted_at
name
address

Employees

Field	Notes
id
remote_id
changed_at
remote_deleted_at
first_name
last_name
nationality
display_full_name
job_title
work_email
tax_id
employment_status
employment_type
home_address
date_of_birth
start_date
termination_date
custom_fields
integration_fields

Employments

Field	Notes
id
remote_id
changed_at
remote_deleted_at
employee_id
job_title
pay_rate
pay_period
employment_type
pay_currency
effective_date
custom_fields
integration_fields

Groups

Field	Notes
id
remote_id
changed_at
remote_deleted_at
name
type

Employee <> Group

Field	Notes
employee_id
team_id
id
changed_at
remote_deleted_at

Input Field	Notes
staffing_entity_id
properties

Feature	Notes
OAuth
Connection Guide
Prerequisites

Employees are created in Oyster as draft employments. Besides name, email, and nationality, the form can set the job title, start date, and yearly salary. A company user completes the remaining role, compensation, and contract details in Oyster and submits the draft to start the hiring process.

If Oyster rejects the job title, start date, or salary, the request fails with the reason Oyster gave and Kombo attempts to delete the draft.

single_select

required

Country
The country the employee is hired in.

text

required

State or region
The state or region the employee is hired in, as the ISO 3166-2 code without the country prefix (e.g., CA for California, BE for Berlin).

object

required

Personal details

Show properties

text

required

First Name
The first name of the employee
Unified field: first_name

text

required

Last Name
The last name of the employee
Unified field: last_name

text

required

Email
The personal email address Oyster invites the employee at.
Unified field: private_email

single_select

required

Nationality
Unified field: nationality

single_select

Billing frequency

object

Role

Show properties

text

Job Title
The title of the position this person is working in
Unified field: job_title

date

Start Date
Oyster rejects start dates in the past.
Unified field: start_date

object

Compensation

Show properties

object

Salary

Show properties

number

required

Yearly Salary
The gross yearly salary.
Unified field: yearly_salary

text

required

Currency
The three-letter ISO 4217 code, e.g. EUR.

General

Features

Guides

HRIS API Reference

Payroll API Reference

General API Reference

DATEV

OysterHR HRIS Integration

Guides and Resources

Connection Setup Guide

Supported Features & Coverage

​Guides and Resources

Connection Setup Guide

​Supported Features & Coverage

Guides and Resources

Supported Features & Coverage