Create the embedded session where the company's admin uploads payroll history files.
Use this endpoint to create the embedded session where the company's admin uploads its payroll history files. Open the returned url in a webview or iframe, the same way as other embedded experiences (see Create embedded experience URL).
Part of Supporting documents. For how this fits into going live, see the guide: Payroll history and going live.
In the experience, the admin drags and drops files (CSV, XLSX, XLS, PDF or ZIP, up to 25 MB each), sees every file Everee has with Everee's review of it, sees what Everee asked for when it needs more, and can remove a file they uploaded there until Everee reviews it. The session's access is limited to the company's payroll history.
Request
| Field | Notes |
|---|---|
eventHandlerName | Required. The name of the JavaScript handler in your page that receives events from the experience. |
brandingEnabled | Optional. Whether Everee branding is shown. Defaults to true. |
Events
eventType | Meaning |
|---|---|
PAYROLL_HISTORY_FILE_ADDED | A file was uploaded. The same fact arrives as a company-onboarding.payroll-history-file-added webhook event. |
PAYROLL_HISTORY_DONE | The admin selected Done. |
DISMISS | The admin closed the experience. If error is true and errorCode is EMB-301, the session expired or isn't allowed: create a new session. |
Sessions expire quickly
The URL is only valid for a short time, given in expiresInMs. Create the session immediately before you show it, not in advance.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
422 | eventHandlerName is missing. |