• Documentation >
• Apps >
• HR management >
• Factorial

Factorial

With Factorial modules in Ibexa Connect, you can watch, create, update, search, retrieve, and delete:

• watch, employee invited and employees, list, retrieve, create, update, terminate, and unterminated employees

• list, create, and update leave types

• watch, list, create, update and delete leaves

• retrieve hiring versions for an employee

• search shifts

• list locations

• list teams

• list company holidays

• search documents

• search folders

To get started with Factorial, create an account at factorialhr.com.

Connect Factorial to Ibexa Connect

To connect Factorial app, you need to obtain the OAuth client credentials.

1. Log in to your Factorial account.

2. In your Ibexa Connect account, insert a Factorial module in your scenario and click the Add button next to the Connection field.

   

3. In the Connection name field, enter a name for the connection. Click Save.

4. Optional: Click Show Advanced Settings and enter the client credentials created in your developer account.

5. Confirm the access by clicking Authorize.

   

   You have successfully connected the Factorial app and can now build scenarios.

Create your own app and client credentials

To create your own app:

1. Log in to your Factorial developer account.

2. Click New Application.

   

3. Enter a name for the application, add the following redirect URIs, and click Keep.

   https://www.integromat.com/oauth/cb/factorial

   https://www.make.com/oauth/cb/factorial

   

4. Copy the Application ID and Secret values to a safe place.

   

You have successfully created the client credentials.

Employees

You can watch employees invited and employees, list, retrieve, create, update, terminate, and unterminated employees using the following modules.

Watch Employee Invited

Triggers when an employee has been invited.

Webhook name	Enter a name for the webhook.

Watch Employees

Triggers when a new employee has been created.

Limit	Set the maximum number of employees Ibexa Connect will return during one execution cycle. The default value is 10.

List Employees

Retrieves a list of employees. Only admins can see all the employees' information, regular users will get a restricted version of the payload as a response.

Limit	Set the maximum number of employees Ibexa Connect will return during one execution cycle. The default value is 10.

Get an Employee

Retrieves an employee.

Employee ID	Select or map the Employee ID whose details you want to retrieve.

Create an Employee

Creates an employee.

For field descriptions, see the Factorial API reference.

Update an Employee

Updates an employee

Employee ID	Select or map the Employee ID whose details you want to update.

For field descriptions, see the Factorial API reference.

Terminate an Employee

Terminates an employee.

Employee ID	Select or map the Employee ID you want to terminate.
Terminated on	Enter the date when the employee was terminated. See the list of supported date and time formats.

Unterminate an Employee

Unterminates an employee.

Employee ID	Select or map the Employee ID you want to unterminate.

Leave Types

You can list, create, and update leave types using the following modules.

List Leave Type

Retrieves a list of leave types.

Limit	Set the maximum number of leave types Ibexa Connect will return during one execution cycle. The default value is 10.

Create a Leave Type

Creates a leave type.

For field descriptions, see the Factorial API reference.

Update a Leave Type

Updates a leave type.

Leave Type ID	Select or map the Leave Type ID whose details you want to update.

For field descriptions, see the Factorial API reference.

Leaves

You can watch, list, create, update and delete leaves using the following modules.

Watch Leaves

Triggers when a new leave has been created.

Limit	Set the maximum number of leaves Ibexa Connect will return during one execution cycle. The default value is 10.

List Leaves

Retrieves a list of leaves.

Limit	Set the maximum number of leaves Ibexa Connect will return during one execution cycle. The default value is 10.

Create a Leave

Creates a leave.

For field descriptions, see the Factorial API reference.

Update a Leave

Updates a leave.

Leave ID	Select or map the Leave ID whose details you want to update.

For field descriptions, see the Factorial API reference.

Delete a Leave

Deletes a leave.

Leave ID	Select or map the Leave ID you want to delete.

Hiring Versions

You can retrieve hiring versions for an employee using the following modules.

Get Hiring Versions for an Employee

Retrieves hiring versions for an employee.

Employee ID	Select or map the Employee ID whose details you want to retrieve.
Limit	Set the maximum number of versions Ibexa Connect will return during one execution cycle. The default value is 10.

Shifts

You can search shifts using the following modules.

Search Shifts

Searches for shifts.

Month	Enter a valid month in the calendar ranging from 01 to 12 in the format MM. For example, 10.
Year	Enter a valid year in the YYYY format. For example, 2020.
Limit	Set the maximum number of shifts Ibexa Connect will return during one execution cycle. The default value is 10.

Locations

You can list locations using the following modules.

List Locations

Retrieves a list of locations.

Limit	Set the maximum number of locations Ibexa Connect will return during one execution cycle. The default value is 10.

Teams

You can list teams using the following modules.

List Teams

Retrieves a list of teams.

Limit	Set the maximum number of teams Ibexa Connect will return during one execution cycle. The default value is 10.

Company Holidays

You can list company holidays using the following modules.

List Company Holidays

Retrieves a list of company holidays.

Limit	Set the maximum number of company holidays Ibexa Connect will return during one execution cycle. The default value is 10.

Documents

You can search documents using the following modules.

Search Documents

Searches for documents.

Employee ID	Select or map the Employee ID whose documents you want to search.
Folder ID	Select or map the Folder ID to search the documents.
Limit	Set the maximum number of documents Ibexa Connect will return during one execution cycle. The default value is 10.

Folders

You can search folders using the following modules.

Search Folders

Searches for folders.

Name	Enter a name to retrieve the list of folders by name.
Active	Select whether to retrieve the list of active employees.
Limit	Set the maximum number of folders Ibexa Connect will return during one execution cycle. The default value is 10.

Other

You can call APIs using the following module.

Note

For the list of available endpoints, refer to the Factorial API documentation.

Make an API Call

Performs an arbitrary authorized API call.

URL	Enter a path relative to https://api.factorialhr.com/api. For example, /v1/employees.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - Search Tasks

The following API call returns all tasks from your account.

URL: /v1/employees

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body.

In our example 6 employees were returned: