Benifex (Preview)
The Benifex platform simplifies global employee benefits, wellbeing, and reward management through a single, unified experience. This connector enables seamless integration with the Benifex platform, providing access to employee data, benefit selections, and eligibility details
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Benifex Support |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Connector Metadata | |
|---|---|
| Publisher | Benefex Ltd |
| Website | https://benifex.com |
| Privacy policy | https://benifex.com/privacy-notice |
| Categories | AI; Human Resources |
Benifex Connector
Benifex specialises in delivering employee experience technology, focusing on areas such as benefits, wellbeing, recognition, and engagement.
We’re on a mission to build remarkable experiences that customers and employees love.
The Benifex connector enables data integration with the Benifex platform.
Publisher: Benifex
Prerequisites
To get started, sign up for a developer account with your Benifex Customer Success Manager. Once approved, you will be provided with a link to the admin section of our developer portal.
You will also be supplied with your unique customer client_id and secret. Once you have these credentials, you will be able to communicate with our APIs.
For more details, refer to the Authentication guide.
Supported Operations
- Get Existing Users: Retrieve existing users by employee ID. Supports pagination.
- Get Existing User: Retrieve a specific user from the Benifex platform.
- Get Summarized Benefits: Returns a summary of currently available and eligible-to-add benefits for a given user.
- Get Detailed Benefits: Returns detailed information about current and eligible-to-add benefits for a given user.
- Get User Benefit Information: Returns information about a specific benefit for a specific user.
For more details on these operations, refer to the API reference documentation.
Obtaining Credentials
To access our API, you will need to obtain the necessary credentials as described in the Prerequisites section.
A JWT access token is obtained using the OAuth 2.0 Client Credentials flow.
Obtain your JWT access token by authenticating with your credentials.
Send a
POSTrequest to the token endpoint URI:
https://hub.onehub.global/oauth2/default/v1/tokenAdd the
Content-Typeheader set toapplication/x-www-form-urlencoded.Include the following in the HTTP body:
client_idclient_secretgrant_type=client_credentials
Getting Started
For full documentation, implementation guides, and sandbox testing, visit the Benifex API Portal.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get detailed available and eligible-to-add benefits of user |
Returns details of current and eligible to add benefits for the requested user |
| Get Existing user |
Get created user at Benifex platform |
| Get Existing Users |
Get created users at Benifex platform by employee IDs with pagination support |
| Get summarized available and eligible-to-add benefits of user |
Returns current and eligible to add benefits for the requested user |
| Get user benefit information |
Returns details of single benefit of the requested user |
Get detailed available and eligible-to-add benefits of user
Returns details of current and eligible to add benefits for the requested user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique ID of the user
|
user-id | True | string |
Specific ID of the user you want to get information about |
|
Response format
|
accept | string |
Defines the media type expected in the response, usually set to application/json to receive JSON-formatted data |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
status
|
data.currentBenefits.status | string |
status |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
annual
|
data.currentBenefits.benefitCost.annual | float |
annual |
|
monthly
|
data.currentBenefits.benefitCost.monthly | float |
monthly |
|
annual
|
data.currentBenefits.employeeContribution.annual | float |
annual |
|
monthly
|
data.currentBenefits.employeeContribution.monthly | float |
monthly |
|
annual
|
data.currentBenefits.employerContribution.annual | float |
annual |
|
monthly
|
data.currentBenefits.employerContribution.monthly | float |
monthly |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
description
|
data.currentBenefits.description | string |
description |
|
sections
|
data.currentBenefits.sections | array of object |
sections |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
content
|
data.currentBenefits.sections.content | string |
content |
|
sections
|
data.currentBenefits.sections.sections | array of |
sections |
|
faqs
|
data.currentBenefits.faqs | array of object |
faqs |
|
question
|
data.currentBenefits.faqs.question | string |
question |
|
answer
|
data.currentBenefits.faqs.answer | string |
answer |
|
needToKnow
|
data.currentBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.currentBenefits.usefulLinks | array of object |
usefulLinks |
|
uri
|
data.currentBenefits.usefulLinks.uri | string |
uri |
|
linkText
|
data.currentBenefits.usefulLinks.linkText | string |
linkText |
|
eligibleToAddBenefits
|
data.eligibleToAddBenefits | array of object |
eligibleToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
description
|
data.eligibleToAddBenefits.description | string |
description |
|
sections
|
data.eligibleToAddBenefits.sections | array of object |
sections |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
content
|
data.eligibleToAddBenefits.sections.content | string |
content |
|
sections
|
data.eligibleToAddBenefits.sections.sections | array of |
sections |
|
faqs
|
data.eligibleToAddBenefits.faqs | array of |
faqs |
|
needToKnow
|
data.eligibleToAddBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.eligibleToAddBenefits.usefulLinks | array of object |
usefulLinks |
|
uri
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
uri |
|
linkText
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkText |
|
timestamp
|
timestamp | string |
timestamp |
Get Existing user
Get created user at Benifex platform
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique ID of the user
|
user-id | True | string |
Specific ID of the user you want to get information about |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
forename
|
data.forename | string |
forename |
|
surname
|
data.surname | string |
surname |
|
dateOfBirth
|
data.dateOfBirth | string |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
line3
|
data.address.line3 | string |
line3 |
|
line5
|
data.address.line5 | string |
line5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
emailAddress
|
data.emailAddress | string |
emailAddress |
|
gender
|
data.gender | string |
gender |
|
nationality
|
data.nationality | string |
nationality |
|
language
|
data.language | string |
language |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | string |
effectiveDateOfMaritalStatus |
|
employeeId
|
data.employment.employeeId | string |
employeeId |
|
additionalEmployeeId
|
data.employment.additionalEmployeeId | string |
additionalEmployeeId |
|
startDate
|
data.employment.startDate | string |
startDate |
|
jobTitle
|
data.employment.jobTitle | string |
jobTitle |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
grade
|
data.employment.grade | string |
grade |
|
department
|
data.employment.department | string |
department |
|
location
|
data.employment.location | string |
location |
|
contractedHours
|
data.employment.workingHours.contractedHours | integer |
contractedHours |
|
fullTimeEquivalentHours
|
data.employment.workingHours.fullTimeEquivalentHours | integer |
fullTimeEquivalentHours |
|
daysPerWeek
|
data.employment.workingHours.daysPerWeek | integer |
daysPerWeek |
|
fullTimeEquivalentFraction
|
data.employment.workingHours.fullTimeEquivalentFraction | integer |
fullTimeEquivalentFraction |
|
holidayDays
|
data.employment.workingHours.holidayDays | integer |
holidayDays |
|
holidayHours
|
data.employment.workingHours.holidayHours | integer |
holidayHours |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
salary
|
data.employment.salaryDetails.salary | double |
salary |
|
salaryEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | string |
salaryEffectiveDate |
|
pensionableSalary
|
data.employment.salaryDetails.pensionableSalary | double |
pensionableSalary |
|
payPeriods
|
data.employment.salaryDetails.payPeriods | integer |
payPeriods |
|
startDate
|
data.employment.contractDetails.startDate | string |
startDate |
|
endDate
|
data.employment.contractDetails.endDate | string |
endDate |
|
type
|
data.employment.contractDetails.type | string |
type |
|
nationalIdentityNumber1
|
data.nationalIdentity.nationalIdentityNumber1 | string |
nationalIdentityNumber1 |
|
timestamp
|
timestamp | string |
timestamp |
Get Existing Users
Get created users at Benifex platform by employee IDs with pagination support
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Employee IDs to retrieve
|
employeeIds | True | string |
Unique employee identifiers used to filter the users being fetched from the Benifex platform |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
pagination.page | integer |
page |
|
size
|
pagination.size | integer |
size |
|
totalPages
|
pagination.totalPages | integer |
totalPages |
|
totalItems
|
pagination.totalItems | integer |
totalItems |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
hasPrevious
|
pagination.hasPrevious | boolean |
hasPrevious |
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
emailAddress
|
data.emailAddress | string |
emailAddress |
|
forename
|
data.forename | string |
forename |
|
surname
|
data.surname | string |
surname |
|
employeeId
|
data.employeeId | string |
employeeId |
|
department
|
data.department | string |
department |
|
jobTitle
|
data.jobTitle | string |
jobTitle |
|
location
|
data.location | string |
location |
|
countryOfWork
|
data.countryOfWork | string |
countryOfWork |
|
dateOfBirth
|
data.dateOfBirth | string |
dateOfBirth |
|
startDate
|
data.startDate | string |
startDate |
|
businessUnit
|
data.businessUnit | string |
businessUnit |
|
gender
|
data.gender | string |
gender |
|
timestamp
|
timestamp | string |
timestamp |
Get summarized available and eligible-to-add benefits of user
Returns current and eligible to add benefits for the requested user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique ID of the user
|
user-id | True | string |
Specific ID of the user you want to get information about |
|
Response format
|
accept | string |
Defines the media type expected in the response, usually set to application/json to receive JSON-formatted data |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
status
|
data.currentBenefits.status | string |
status |
|
eligibleToAddBenefits
|
data.eligibleToAddBenefits | array of object |
eligibleToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
status
|
data.eligibleToAddBenefits.status | string |
status |
|
timestamp
|
timestamp | string |
timestamp |
Get user benefit information
Returns details of single benefit of the requested user
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique ID of the user
|
user-id | True | string |
Specific ID of the user you want to get information about |
|
Unique benefit identifier
|
benefit-key | True | string |
Specific key used to identify which benefit information you want to retrieve for the given user |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
data.status | string |
status |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
annual
|
data.benefitCost.annual | double |
annual |
|
monthly
|
data.benefitCost.monthly | float |
monthly |
|
annual
|
data.employeeContribution.annual | float |
annual |
|
monthly
|
data.employeeContribution.monthly | float |
monthly |
|
annual
|
data.employerContribution.annual | float |
annual |
|
monthly
|
data.employerContribution.monthly | float |
monthly |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
description
|
data.description | string |
description |
|
sections
|
data.sections | array of object |
sections |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
content
|
data.sections.content | string |
content |
|
sections
|
data.sections.sections | array of |
sections |
|
faqs
|
data.faqs | array of |
faqs |
|
needToKnow
|
data.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.usefulLinks | array of object |
usefulLinks |
|
uri
|
data.usefulLinks.uri | string |
uri |
|
linkText
|
data.usefulLinks.linkText | string |
linkText |
|
timestamp
|
timestamp | string |
timestamp |