This guide explains how Employee Sync works, which statuses exist, and how to view them on the Employee page.
1. Possible Employee Sync Statuses
An employee can have multiple statuses for each third-party integration. These statuses are visible to the user:
Synced: All changes have been successfully applied to the third party.
Sync failed: The third party returned errors during the sync.
Syncing: The sync is currently in progress.
Sync pending: Changes were made to the employee in the last 5 minutes. If no further changes are made for 5 minutes, the sync will start automatically.
⚠️ Note: Each third party the employee is synced to has its own status for that employee.
2. General Workflow of a Sync
Customer makes a change
A change is made to an employee.Check for fields to sync
Employee Sync checks if the changed fields are relevant for any third party.This may differ per integration.
Refer to the field icons or the integration documentation for details.
Start of grace period
If changes are relevant for an integration, a 5-minute grace period begins.Status for that integration becomes Sync pending.
Start of sync
If no further changes are made for 5 minutes, the sync automatically starts.Status for that integration becomes Syncing.
Sync completed
If successful: status becomes Synced
If an error occurs: status becomes Sync failed
Any errors are displayed to the user for resolution.
3. Sync Status on the Employee Edit Page
When an employee is eligible for Employee Sync, extra information appears on the Employee page:
Status Badge
A status badge is visible at the top of the page.
This badge shows the most important status(es) of all third-party syncs for this employee.
We also indicate which fields are sync on the profile of the employee.
