For the complete documentation index, see llms.txt. This page is also available as Markdown.

Employee Management

Push employee data into flaik (and, optionally, into the resort's POS) from your HR or payroll system of record. This is the only write group in flaik Connect — every other group is read-only — and processing is asynchronous: submit a request, receive a request id, then poll for the result.

A single submit can target up to four destinations in one call (flaik employee record, POS Person, POS Employee, POS Instructor) using the actionUpsert* flags. Each destination's success/failure is reported independently in the status response, so partial-success outcomes are first-class.

Pages in this group

  • Upsert Employee — submit a create-or-update request (POST /api/employee/upsert). Required scope: flaik.connect.api.write.

  • Upsert Status — poll for the processing result (GET /api/employee/upsert/{upsertEmployeeRequestId}). Returns the four-state lifecycle (Pending/Processing/CompletedSuccessfully/CompletedWithError) plus per-destination identifiers and error messages.

Typical sync pattern

  1. SubmitPOST the upsert. Receive upsertEmployeeRequestId.

  2. Poll — every few seconds, GET the status endpoint with that id. Most requests reach a terminal state within 30 seconds.

  3. Process result — read the per-destination *HasError flags. Partial success is possible; the flaik write may succeed even if a POS write fails.

  4. Retry — for failed destinations, fix the cause and submit again with only the failed actions enabled. Do not blindly resubmit the whole payload.

Optionally, supply a webHookUrl on the submit and Flaik will POST the result to it when processing completes — letting you skip the polling loop in steady state. Polling remains useful as a safety net.

Last updated

Was this helpful?