Folks Help Center
Maximize your experience with Folks through our detailed documentation.
Integrations & API
Payroll management software
Which software is Folks integrated with?
We support our clients in their payroll management processes. Folks offers native integrations with the following software:
Time management software:
Employee Recognition:
- Applauz (Import of Folks profiles only, API)
Public API
In addition to native integrations, we offer a public API. This API allows our clients to connect their custom software or any other software with which we do not have a native integration. This feature is available with the Performance plan.
Contact Us
For more information on the desired integration, please contact our technical team at the following email: support@folkshr.com.
Folks x Nethris Integration Overview
Folks HR offers integration possibilities with Nethris, a payroll management platform, to centralize your HR and payroll information and ensure efficient employee monitoring.
In this article, you'll learn everything there is to know about the Folks x Nethris integration.
How does the integration work?
The integration allows you to perform the initial import of your employees into Folks, then synchronize updates to your employees' files and send their timesheets to Nethris.
What are the integration's features?
- Communication of employee files between the two platforms
- Communication of hours worked as well as vacation and absence days
- Employees can update their own information whenever they need to, and have it transferred between the two platforms without any complex action on their part
Who can benefit from the integration?
- Accounting technicians and payroll managers who want to avoid duplicate data entry and loss of information
- Employers who want to facilitate payroll management throughout their organization
- Managers who want to retrieve key information from employee files on their favorite platform, in just a few clicks
What are the benefits of integration?
- Self-service employee for quick updates, daily time-savings and greater flexibility
- No duplicate employee and payroll data entry
- Elimination of repetitive tasks and manipulations
How can I get started with Folks x Nethris?
Contact the Folks support team to configure the integration.
Folks x Payworks Integration Overview
Folks HR offers integration possibilities with Payworks, a payroll management solution in order to centralize your HR and payroll information and ensure efficient employee monitoring.
In this article, you'll learn everything there is to know about the Folks x Payworks integration.
If you missed our webinar, you can watch the recording here: Deluxe HR to Folks HR : Transition Meeting & Payworks Integration.
How does the integration work?
The integration allows you to transfer your employees' files and timesheets to Payworks. Employee file synchronization is unidirectional and takes place automatically every 4 hours.
In addition to employee file synchronization, it is possible to create and edit employees in Folks and synchronize them with Payworks.
Timesheet synchronization must be performed manually.
Fields imported into Payworks
Here is the list of fields imported into Payworks:
| Folks field | Payworks field |
| Personal information | |
| First name | Legal first name |
| Last name | Legal last name |
| Gender | Gender |
| Birth date | Birth date |
| Language | Language |
| Address | Address |
| City | City |
| Province | Province |
| Postal code | Postal code |
| Phone | Cell phone |
| Alternate phone | Home phone |
| Social insurance number | SIN |
| Personal email | Personal email |
| Corporate information | |
| Employee number | Employee number |
| Employment province | Tax province |
| Business number | Business number |
| Start date | Start date |
| Seniority date | Seniority date |
| Work phone | Office phone |
| Corporate email | Company email |
| Salary (The hourly or per-paycheck salary is sent with the salary type and is secondary information to the salary types.) | Rate/amount |
| Salary (2nd one) | Primary earning (Hourly rate = Hours paid, Per pay = Salary) |
| Hours per day | Hours per pay |
| Pay group | Pay group |
| Payment info - Transit | Transit |
| Payment info - Institution | Bank |
| Payment info - Account | Account number |
| Field sent only during employee creation | |
| Start date | Insurable date |
What are the integration's features?
- Communication of employee files between the two platforms
- Communication of hours worked as well as vacation and absence days
- Employees can update their own information whenever they need to, and have it transferred between the two platforms without any complex action on their part
Who can benefit from the integration?
- Accounting technicians and payroll managers who want to avoid duplicate data entry and loss of information
- Employers who want to facilitate payroll management throughout their organization
- Managers who want to retrieve key information from employee files on their favorite platform, in just a few clicks
What are the benefits of integration?
- Self-service employee for quick updates, daily time-savings and greater flexibility
- No duplicate employee and payroll data entry
- Elimination of repetitive tasks and manipulations
How do I get started with Folks x Payworks?
Contact the Folks support team to set up the integration. We'll send you a form to complete in order to authorize the sharing of your Payworks data with Folks. Once authorization has been received, we'll walk you through the configuration steps.
Time management software
Folks x Agendrix Integration Overview
Folks HR offers integration possibilities with Agendrix, a time tracking system, for efficient staff scheduling management and complete centralization of your HR data.
In this article, you'll learn everything there is to know about the Agendrix x Folks integration.
How does the integration work?
Folks to Agendrix
The integration allows you to sync your employee files and information. Employee files in Folks are automatically created in Agendrix for you, avoiding duplicate work.
Creating, editing, and deactivating employees in Folks and synching them with Agendrix is also possible.
Agendrix to Folks
The integration also allows for the sync of absences, vacations, and overtime. Once absence, vacation, and overtime requests have been approved in Agendrix, they will be displayed in Folks' Summary and Detailed Analysis of vacation, absence, and overtime pages after the 4-hour synchronization delay.
To ensure smooth integration, a mapping of reasons (types and IDs) is required between Folks and Agendrix, as everything is 100% customizable in both.
If there is a change in the reason structure (types and IDs), please let our support team know so that adjustments can be made.
Employee and request synchronization
Automatic synchronization takes place every 4 hours and applies to all synchronized items. You must wait for the 4-hour delay before synchronization takes place.
Here is the list of synchronized fields:
| Folks field | Agendrix field |
| Folks to Agendrix | |
| Employee number | Employee number |
| First name | First name |
| Last name | Last name |
| Working site | Primary location |
| Position | Role |
| Start date | Date of hire |
| Birth date | Date of birth |
| Address | Street address |
| Phone | Numbers, ext. |
| Alternate phone | Numbers, ext. |
| Corporate email | |
| Work phone | Numbers, ext. |
| Agendrix to Folks | |
| Absences | Time off - Type |
| Vacation | Time off - Type |
| Banked Hours | Work time bank |
What are the integration's features?
- Absences, vacation and overtime hours entered in Agendrix are shared on Folks’ platform
- Employee files in Folks are shared on Agendrix’s platform
- Automated employee creation, modification and deactivation depending on the context
Who can benefit from the integration?
- HR departments and managers who want to ensure operational time tracking and management
- Shift-based businesses with specific work schedules
- Seasonal employees, volunteers, hourly workers, etc.
What are the benefits of integration?
- Better sharing and synchronization of information between HR, payroll and operations management software and services
- Optimized tracking of employees, HR data and work schedules
- Reduced risks of duplicate data entry and loss of information
How do I get started with Agendrix x Folks?
Contact our support team to activate and set up the integration.
Folks x Evolia Integration Overview
Folks HR software offers integration possibilities with Evolia, a time tracking system, for efficient staff scheduling management and complete centralization of your HR data.
In this article, you'll learn everything there is to know about the Folks x Evolia integration.
How does the integration work?
Folks to Evolia
With Folks x Evolia integration, you can synchronize your employees' files with Evolia. This synchronization takes place automatically every 4 hours, but you can request that it be done manually.
You can also create, edit and deactivate employees in Folks and synchronize them with Evolia. All changes to employee profiles are made in Folks as usual, with a few exceptions. Please note that certain items may not be synchronized if your company specifically requests this.
|
Employees who are no longer employed will be automatically deactivated in Evolia, and can no longer be assigned to shifts once they have left. To terminate an employee's employment, simply go to Folks, Human Resources Management > Turnover > Control Panel and fill in the dedicated form. Once this operation has been saved, the employee will be archived in Evolia at the end of the day. Note that the Make inactive function in Folks can also be used to archive an employee, but this will not be calculated in the statistics as an “official” departure in Folks. |
Evolia to Folks
Absences and vacations in Evolia are also synchronized with Folks. However, it is possible to deactivate synchronization of these items. If synchronization is retained, it takes place automatically every 4 hours (or manually, on request).
Please note that we do not support the cancellation of requests already sent to Folks.
Fields imported
Here's the list of imported fields. Mandatory fields are marked with an asterisk.
Note that each employee must have a unique ID number, email and phone number to enable synchronization. This information enables them to access their Evolia account. When several software applications are integrated, make sure you have the same employee number in each system.
| Folks field | Evolia field |
| Folks to Evolia | |
| Last name* | Last name* |
| First name* | First name* |
| Language | Communication language |
| Phone* (Make sure that in Folks, the phone is the cell phone) | Mobile number* |
| Personal email* | Email* |
| Employee number* | Employee ID* |
| Start date | Hiring date |
| Job type | Status |
| Hourly wage | Hourly wage |
| Active / inactive | Active / inactive |
| Evolia fields (Activated in company settings in Folks) | |
| Location | Locations |
| Position | Positions |
| Team | Teams |
| Vacation bank | Null |
| Sick leave bank | Null |
| Evolia to Folks | |
| Absences | Absences (Customizable in Evolia) |
| Vacation | Vacation (Customizable in Evolia) |
| Overtime | |
What are the integration's features?
- Absences and vacations entered in Evolia are shared on Folks’ platform
- Employee files in Folks are shared on Evolia’s platform
- Automated employee creation, modification and deactivation between the two platforms
Who can benefit from the integration?
- HR departments and managers who want to ensure operational time tracking and management
- Shift-based businesses with specific work schedules
- Seasonal employees, volunteers, hourly workers, etc.
What are the benefits of integration?
- Better sharing and synchronization of information between HR, payroll and operations management software and services
- Optimized tracking of employees, HR data and work schedules
- Reduced risks of duplicate data entry and loss of information
How do I get started with Folks x Evolia?
Contact your Evolia Customer Success Manager to set up the integration. Among other things, you'll need to provide your Folks API key.
Folks API
API Access Guidelines and Request - HRIS
This guide explains how to request and use your Folks HRIS API access. Two environments are available depending on your needs.
API Access Options
Sandbox
Test environment using fictitious data only. Ideal for developers and partners before moving to production.
Production
Access to your real data in Folks. Requires enhanced security measures and an approved request.
Request Procedure
- Choose your environment: Sandbox for testing, Production for live integration.
- Submit the request form specifying the type of access you need.
Once the feature is activated by Folks, an administrator can generate an API key via: Settings > Integrations > API Key Management
See also: Generate a Folks API Key
Security Considerations and Responsibilities
Once the API is activated, you can generate keys and define their permissions. These keys provide direct access to your data and must be handled with the same level of care as admin platform credentials.
As the platform operator, you are responsible for securing the generated keys as well as the administrator account used to create them. Any compromise of these accesses is your responsibility.
For the full terms of use: folksrh.com/termes-api
Excessive Usage
Clients are limited to 60 requests per minute. Exceeding this limit will result in a temporary block with a 403 Forbidden response.
If you have any questions, our support team is available to help.
Generate/Edit a Folks API Key
This article explains how to generate an API key in Folks.
If you do not have access to the API key management page, please ask our team to activate it. Only a company administrator can generate API keys.
|
When generating an API key, it will be marked V2. This is the new version of the API key, useful for employee modules and their personalized fields, time management and organizational structures (see Folks API Documentation). By default, the API key management page contains a V1 key. This key is used to access timesheet files and the ATS. This key can be updated as required from the company page. |
- In Folks, navigate to the API key management page (Admin > Company > API Key Management).
- In the top right-hand corner of the page, click Generate new API key.
- In the window that opens, give your API key a name and specify an expiration date, if desired.
- Under the Parameters section, you can activate the options for granting access to sensitive information (SIN, salary and banking information) and to employees' personal information.
- Under the Content of the API key section, you can select the desired access levels for employees, custom fields, absences, overtime, vacation, balances, positions, departments, working sites and admin (corresponds to all positions, departments and working sites).
- Click Generate. A message containing the unique identifier and the API key (secret key) will appear.
Warning! The key will only be displayed once. Copy it in a safe place so as not to lose it, then close the window.
You can edit the parameters of a V2 API key by clicking the ellipsisand selecting Edit. When you save your changes, all access tokens associated with the key will become invalid.
To delete a V2 API key, simply click the ellipsisand select Delete.
Create/Edit Custom Fields via API
Use the following operation to create (POST) or update (PUT) a custom field for the company or for a specific employee (see https://api.folkshr.app/api/documentation#/Custom%20Fields).
POST /api/v2/employees/{employee}/custom-fields
PUT /api/v2/employees/{employee}/custom-fields/{custom-fields-id}
When creating or editing a custom field, you can define a value as follows.
To define a value for a company custom field:
{
"employee_id": "null"
}To define a value for a custom employee field:
When a value is sent for an employee, if a value already exists, the existing value is overwritten.
{
"employee_id": "target_employee"
}The custom field value must respect the custom field type schema. When the value “null” is sent, the value associated with the custom field and the employee is removed.
- For an Alpha numeric custom field, a string must be supplied.
- For a Date custom field, a date in “YYYY-MM-DD” format must be supplied.
- For a Drop-down list custom field, the identifier of an option must be supplied.
Can't find What You're Looking For?
Start a conversation with our team and get the answers you need.