Onboard and offboard
Automate bringing an employee population into your application, and keep their profiles up-to-date as they change
1. Onboard your user
Your user signs into your app, and navigates to the screen to initialize the onboarding employees function through your integration with Merge. Merge begins syncing Employee data.
Configure Field Mappings in Merge Link (end-user) or Merge Dashboard to bring in custom fields relevant to an an end-user, if needed.
Before your user Links, use Scopes in the Dashboard to configure what information Merge and your app is able to access from a third-party platform.
2. Pull employee data from Merge
Your app is able to get the data it needs with:
- Use GET /Employees to perform an ingest of an end-user’s current employees, and onboard them onto Center’s platform.
- Use endpoints like GET /Groups, GET /Locations, GET /Employments to understand additional dimensions about employees for grouping in your product, or auto-provisioning.
3. Refresh data regularly to track joiners and leavers
After your initial sync, regularly call the GET /Employees endpoint using the modified_after query parameter to track employees joining & leaving, as well as changes to existing employees to keep user tables up to date.
The fields status, start date, and termination date will all allow you to precisely track joiners and leavers.
4. Give users value, faster
- With onboarding handled automatically, allow your users to access the parts of your application they drive value from.
