Options details

You can find here the different options HeyTeam can support.

Enrollee

There are different ways to map its identifier : custom field(recommended), Heyteam ID, professional email or personal email).

The chosen identifier will be used to check if the user already exists in Heyteam before trying to create the onboarding.

📘

What if the user already exists ?

There is no update process yet in place for now if the user is already in Heyteam, but it will come soon. If the user already exists, nothing will be processed.

Program

A program will be defined by default for all the POST request on the users/enroll endpoint.

The different onboarding modes :

• Draft : this mode creates the user but does not generate the program (it has to be manually generated from the platform)
• Full : this mode creates the user and generates the program (the user will received an email invitation)
• Full or Draft : this mode tries to create the user and to generates the program but keeps the user if the program generation fails

Main entities

HeyTeam supports 4 main entities by default : job positions (Developer, HR manager, ...), departments (HR, Tech, Sales,...), sites (Paris, New-York,...) and contracts (short term, full time, freelance,...).

There are different ways to map each entity identifier are available: Heyteam Id, Label, custom field value (recommended).

There is the possibility to add a fallback, to autocreate the entity if missing in Heyteam and it is possible to add the following filters :

• Whitelist : will allow onboarding if given entity is in the list
• Blacklist : will not allow onboarding if given entity is in the list

Repositories

HeyTeam support also as many custom entity as you would like to have (BU, Region, ...) : we call them repositories in the API since it is mostly your data stored in HeyTeam.

There are different ways to map its identifier : with the key (recommended) or Label.

Possibility to add a fallback, to autocreate if missing in Heyteam and to add filters (same rules as for the main entities)

Supervisors

There are different ways to map their identifier : with custom field (recommended), Heyteam ID or professional email.

It is possible to autocreate each supervisor if missing in Heyteam (only if all mandatory data are present in the sent 'data' object).

Roles

There are two ways to map its identifier: label or Heyteam Id.

As it is possible to define a default supervisor, we can define what identifier to use for it : by professional email, id or custom field (recommended).

Team (options for each role) :

For each role, those two options will be defined :

• Role identifier value (based on the identifier setup in 'Roles')
• Default supervisor identifier value (based on the identifier setup for the default supervisor in 'Roles')