Streamline Employee Onboarding and Offboarding with the HRIS API

Effortlessly synchronize employee data from over 50 HRIS providers into your product and maintain up-to-date employee records as they evolve. Apideck's HRIS API supports both polling and webhook-based approaches for seamless integration.

Prerequisites

Before you begin, ensure you have:

An Apideck account
Completed the steps in the Get Started guide to set up your application

Note

For testing purposes, we recommend setting up a sandbox account with an HRIS provider. You can find sign-up links for many popular HRIS providers in the Apideck admin when activating a connector. Here are some recommended providers with a free trial: Personio, BambooHR, and HiBob.

Implementation Guide

1. Enable HRIS Integration for Your Customers

When a customer signs into your app and navigates to the employee onboarding screen:

If applicable, use Apideck Vault (consumer) or Apideck Dashboard to Configure Field Mappings, allowing you to map custom fields relevant to the end-user.

2. Retrieve Employee Data

Fetch the necessary data using these endpoints:

```
/hris/employees
```
: Import active employees and onboard them to your product.
```
/hris/departments
```
and
```
/hris/companies
```
: Gather additional employee information for grouping or auto-provisioning in your product.

3. Maintain Up-to-Date Employee Records

Choose one of the following methods to keep employee data current:

Option A: Utilize Webhooks (Recommended)

After the initial import, subscribe to these webhook events:

These events will help you track new hires, departures, and changes to existing employee records. Follow our Webhooks guide to set up your product for receiving these events.

Option B: Implement Polling

Alternatively, you can regularly call the

/hris/employees

endpoint to track changes. Pay attention to these fields:

employment_status
employment_start_date
employment_end_date

These fields will help you monitor employees joining and leaving your organization.

Get Started Today

Ready to streamline your employee onboarding and offboarding process? Discover how Apideck can unlock hundreds of B2B integrations for your business by signing up for free or talking to an expert.