Overview

When it comes to user onboarding, simplicity is key. Fortunately, the HeyTeam API offers not one, but two methods to simplify this workflow : with or without configuration.

Draft Onboarding

With this method of onboarding, you can start using the API immediately. However, you can't generate a program right away, which means that you'll need to manually control the data and start the program on the platform for your users to begin their experience with HeyTeam.

This approach is useful if you want to manually control program data before starting and don't have a way to do it automatically. Program data can include start date, department, job, site, etc.

Onboarding with options

With this way of onboarding, you will need HeyTeam to build an API onboarding configuration for you to allow you to start using the endpoint. But this configuration can solve lots of issues and the program can start right away : no need for manual control, once the request has been made, nothing more to do, the onboarding is starting.

This approach is useful if you want to simplify the onboarding on your side by sending the data as you want in a POST request to a single endpoint.