Skip to main content

Staff Member Onboarding

Once a business has been boarded, we have to match and sync staff member's records. In order to display staff member info on the screen and to identify which staff member is receiving tips, we use employeeId as an unique identifier. This identifier can be any id that is unique on the business/account level.

Currently we offer 2 different ways for syncing and matching staff members:

  • Redirect URL
  • Login Endpoint

Redirect URL (recommended)#

You can provide a Redirect URL to a web login page that offers staff members to use their POS login credentials to login. Tippy will redirect staff members during the signup with Tippy flow or from profile screen on Tippy app to that redirect url. Tippy will append a callback url to your redirect url. On successful login, POS must redirect user back to the callback url and append the employeeId parameter with the value of that staff member's employee id.

Explained with an example:

  1. Before launch, POS provides a redirect url https://best-pos.com/tippy-login.
  2. Tippy appends a callback url and redirects user to https://best-pos.com/tippy-login?callback=https://meettippy.com/callbacks/bestpos
  3. On successful login, POS redirects user back to Tippy callback url https://meettippy.com/callbacks/bestpos?employeeId=xxxxx

Login Endpoint#

You can provide a login endpoint that Tippy can call. This endpoint must return the employeeId. From the user experience point of view, the staff member will be presented with an option to Login via POS either on signup with Tippy flow or on profile screen inside the Tippy app. The staff member will enter their POS credentials (username and password) and Tippy system will forward the credentials to the provided endpoint in exchange for the employeeId.

Talents assign#

We provide endpoints for listing talents that belongs to account, you can pass storeId to filter only users that belongs to specific location. After that you can match users employeeId by passing identifier to assign endpoint. Check onboarding API reference.

Further API calls#

In order to create a tip on Tippy via API, the employeeId will have to be provided. This is how Tippy identifies the user and distributes tips to proper deposit destination.

Since Tippy relies on POS generated employee id values, the POS should create tips via API regardless of the staff member's onboarding status. In many cases, customers will want to tip staff members before the they had a chance to complete the onboarding. In those cases, POS can simply assume that they have already completed onboarding and create a tip with the employeeId. Tippy will be collecting tip information for the employee and once the staff member completes the onboarding process, Tippy will match them and transfer pending tips to their deposit destination.