Skip to main content

Freshteam

Yellow.ai Integration with Freshteam enables you to seamlessly access Freshteam services. Any customer who has an account in Freshteam will be able to connect it with yellow.ai. Using this integration one can fetch employee info, create and manage time off requests, and retrieve job posting information from Freshteam.

1. Configure freshteam

Configuring the integration with Freshteam is straightforward. Follow the steps below to integrate Freshteam:

  1. Navigate to integration tab

Inside your project, from the switcher, open Integrations, search for Freshteam in the search bar or you can find Freshteam under HR.

  1. Connect your Freshteam account

Follow the below steps to enable Freshteam integration for your bot:

  • From the drop-down select API key, generate or use the existing API key.

  • Provide your Freshteam Domain and API key details in the Freshteam Integration page in cloud.
  • Click connect to connect your freshteam account to the bot.
  • If you have multiple accounts, follow the above mentioned steps to add each of them.
note
  1. Enter a unique name for each account to easily identify them within the yellow.ai platform. It is recommended to use a name that aligns with its purpose for better usability.
  2. You can add a maximum of 15 accounts.
  3. In a two-tier environment, such as bots with only Development/Live environments, you can add account names only in the development mode. Once added and flows have been built, in the Live mode, you can only choose the account names and not edit them.
  4. In a three-tier environment, such as bots with Staging/Sandbox/Production modes, in Staging and Sandbox modes, you can add and edit new accounts. However, in Production, only the account details added in Staging will be available. You can only map in the production environment.

2. Use cases

Following are the use-cases which are currently accommodated in the Integration:

2.1 List all employees

List all employees integration node helps in retrieving all the employees available in Freshteam. One can retrieve employee information by applying sort and sortType filters as well.

note
  • Only users in HR Partner, Admin, and Account Admin roles can access this API.
  • When multiple accounts are added, select the appropriate account for each node, allowing you to leverage the unique functionalities of each account for their intended purposes.

Node Sample Inputs

ParameterTypeSample
SortStringfirst_name/last_name/employee_id
SortTypeStringasc/desc

Return Value

List all employee's integration node returns the value of array type, use array variable as an output variable.

1.2 Retrieve employee information

Retrieve employee information integration node helps in retrieving a particular employee based on the employee id provided.

note

Only users in HR Partner, Admin, and Account Admin roles can access this API.

Node Sample Inputs

ParameterTypeSample
EmployeeIDNumber5000402776

Return Value

Retrieve employee information integration node returns the value of object type, use object variable as an output variable.

1.3 List all time-off types

List all time off types integration node helps in retrieving all the time off types available in the freshteam.

note

Only users in HR Partner, Admin, and Account Admin roles can access this API.

Return Value

List all time off types integration node returns the value of array type, use array variable as an output variable.

1.4 List all time off requests

List all time off requests integration node helps in retrieving all the time off requests applied by an employee based on the employee id provided.

note

Only users in HR Partner, Admin, and Account Admin roles can access this API.

Node Sample Inputs

ParameterTypeSample
EmployeeIDNumber5000402776

Return Value

List all time off requests integration node returns the value of array type, use array variable as an output variable.

1.5 Create a time off request

Create a time off request integration node helps in applying for leave(time off).

Node Sample Inputs

ParameterTypeSample
StartDateString2022-09-19
EndDateString2022-09-19
LeaveTypeIDNumber5000063084
CommentsStringFever, cold, and headache
OptionalLeaveDaysArray[]
NotifyArray[]
AddToCalendarBooleanTrue
AutoDeclineEventsBooleanTrue

Return Value
Create a time off request integration node returns the value of object type, use object variable as an output variable.

1.6 Approve a time off request

Approve a time off request integration node helps in approving a leave based on the time off id provided.

note

Only users in HR Partner, Admin, Reporting Manager, and Account Admin roles can access this API.

Node Sample Inputs

ParameterTypeSample
TimeoffIDNumber5000402776

Return Value

Approve a time off request integration node returns the value of object type, use object variable as an output variable.

1.7 Cancel a time off request

Cancel a time off request integration node helps in rejecting a leave based on the time off id provided.

Node Sample Inputs

ParameterTypeSample
TimeoffIDNumber5000402776

Return Value

Cancel a time off request integration node returns the value of object type, use object variable as an output variable.

1.8 List all Job Postings

List all job postings integration node helps in retrieving all the available open jobs in an organization. One can apply an optional filter “title” for returning job information based on that title.

Node Sample Inputs

ParameterTypeSample
TitleStringSample Job Posting

Return Value

List all time off requests integration node returns the value of array type, use array variable as an output variable.

1.9 Retrieve Job Posting information

Retrieve Job posting information integration node helps in retrieving available job information based on the job id provided.

Node Sample Inputs

ParameterTypeSample
JobIDNumber5000402776

Return Value

Retrieve Job posting information integration node returns the value of object type, use object variable as an output variable.

References