FreshTeams
Freshteams is a cloud-based HR and applicant tracking solution offered by Freshworks. This solution has simplified the HR work by helping them to source, screen, interview, and hire candidates. Freshteams also offers time-off management features and email templates for existing employees.
Authorization
OAuth 2.0
OAuth 2.0 is an authorization framework for third-party applications. On behalf of a resource owner, third-party applications like Freshteam use OAuth 2.0 to get limited access to an HTTP service. The frameteam also enables an approval interaction of the resource owner with the HTTP service. In addition, OAuth 2.0 supports direct access to the HTTP services by the third-party application.
If you haven't already signed in, you will be redirected from the application to your authorization URL, requesting an authorization code. Freshteams receive the requested authorization code from the server. Now, Freshteams will request your access token URL, for exchanging the code obtained for an access token. Your authorization server will return an access token to Freshteams. It will then makes a request to your UserInfo URL with the access token obtained. Your server will then return the user’s information in JSON format.
When you create your Freshteams app, you must be sure to enter Sapper's OAuth callback URL -Sapper.
To Log in you need to use your organization URL. Click on the 'Security' icon to generate this.
Choose OAuth 2.0 as your login protocol and the IdP of your choice. Now, use the Redirect URL provided by Freshteams in your Identity provider configuration.
You will be presented with the following fields that you need to fill with the information you get from the IdP side:
Client Id
Client secret
Authorization URL (to redirect to the login page of IdP, if not already logged in)
Access token URL (to get the user access token)
Logout URL (optional - user will be redirected to this page on logout)
User info URL (to get the user information based on the access token obtained by invoking the access token URL)
Name | Description | Example |
Client Id | Client Id is generated by IdP | xxxx |
Client Secret | Client secret is generated by IdP | xxxx |
Authorization URL | Authorization URI is where the user should be sent for authorization purposes |
|
Access Token URL | Access Token URL is required to ensure your platforms are safe from unauthorized access |
|
Logout URL | Logout URL is where the user should be redirected post logout | |
User Info URL | User info URI will be used to fetch user info |
|
For more information visit Freshteams OAuth2.0
Freshteams Connection
Freshteams OAuth2.0 Connection
Input | Key | Description | Example |
Select application | application | Select Freshteams application |
|
Connection type | connection type | Select the type of connection. | REST |
REST connection type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection name | name | Provide a name for the connection. | Freshteams connection |
Connection description | description | Provide a description for the connection. |
|
Host name | host | Provide a string value for the URL of user's Freshteams account. |
|
Grant type | grant type | Provide the grant type - Authorization code, Password, Client Credentials. |
|
Actions
Get New hires
Get New hires | key: getNewhires
Get Employees FreshTeams
Get Employees on FreshTeams | key: getEmployees
Get Roles
Get Roles| key: getRoles
Create an Employee
Create an Employee| key: createEmployee
Input | Key | Description | Example |
|---|---|---|---|
First Name | firstName | Mention the first name of the employee | Mary |
Last Name | lastName | Mention the last name of the employee | Smith |
Official Email | emailID | Provide an official email id. An email address is the identification of an electronic mailbox. It has two parts, namely, a local part and the domain. | |
Role id’s | RoleID | A role ID is a unique identification number that all roles in Freshteams are automatically given. | 1001HR, 1002Marketing |
Get Time off
Get Time off| key: getTimeoff
Get Employee by ID
Get Employee by ID| key: getEmployeebyID
Input | Key | Description | Example |
|---|---|---|---|
Employee Id | employeeID | An employee ID is a code used by an employer to uniquely identify the people working at an organization. Employee IDs allow streamlined, accurate record keeping, and they help preserve confidential information.
| 68319 |
Update Employee
Update Employee| key: updateEmployee
Input | Key | Description | Example |
|---|---|---|---|
First Name | firstName | Mention the first name of the employee | Mary |
Middle Name | middleName | Mention the middle name of the employee | Elizabeth |
Last Name | lastName | Mention the last name of the employee | Smith |
Official Email | emailID | Provide the official email id of the employee. An email address is the identification of an electronic mailbox. It has two parts, namely, a local part and the domain. |
|
Role id’s | RoleID | A role ID is a unique identification number that all roles in Freshteams are automatically given. | 1001HR, 1002Marketing |
Employee Id | employeeID | An employee ID is a code used by an employer to uniquely identify the people working at an organization. Employee IDs allow streamlined, accurate record keeping, and they help preserve confidential information. | 68319 |
Create New Hires
Create New Hires| key: CreateNewhires
Input | Key | Description | Example |
|---|---|---|---|
First Name | firstName | Mention the first name of the new hires | John |
Last Name | lastName | Mention the last name of the new hires | Smith |
Personal Email | personalEmailID | Provide the personal email id. An email address is the identification of an electronic mailbox. It has two parts, namely, a local part and the domain. | |
Joining date | joiningDate | Mention the joining date of the | 14th of April 2022 |
Get Job Postings
Get Job Postings| key: GetjobPostings