Skip to main content

BambooHR HR Source

nexusID integrates with BambooHR as an authoritative HR source for the joiner/mover/leaver (JML) lifecycle, pulling the employee directory over the BambooHR API.

Add it as an HR_SOURCE integration (provider BambooHR) in Admin → Integrations; see HR Sources for the model. Config fields:

BambooHR — Add HR source connection fields

FieldNotes
subdomainyour BambooHR company domain (used in the API URL)
apiKeyBambooHR API key — used as the Basic-auth username (encrypted at rest)
employeesPathdefault /employees/directory

nexusID calls GET https://api.bamboohr.com/api/gateway.php/{subdomain}/v1{employeesPath} with Authorization: Basic base64(apiKey:x) and Accept: application/json.

Field mapping (employee → identity)

CanonicalDefault BambooHR field
employeeId (required)id
emailworkEmail
firstName / lastNamefirstName / lastName
displayNamedisplayName
jobTitlejobTitle
departmentdepartment
managersupervisor
statusstatus

The default /employees/directory endpoint lists active employees only (no status column). For leaver detection, point employeesPath at a BambooHR custom report that includes a status / employment-status column.

Where it lives in code

  • Provider: modules/integration/hr-bamboohr/.../BambooHrProvider.kt (+ BambooHrApiClient.kt)
  • DB sync: HrSourceSyncService (no per-vendor connector needed)