Create onboarding tasks

Create one or more onboarding tasks using the supplied details.

An onboarding task defines a step a worker must complete, such as providing information or signing a document. It is a reusable definition; assigned tasks track a particular worker's progress.

Body Params
uuid
required
string
required
string
string
enum
required
string
enum
Allowed:
number
content
object
boolean
reviewerEmployerUuids
array of strings

Who reviews this task: employer uuids, or the roles supervisor and opening_owner resolved per worker. Allowed only when requireReview is true. Empty names no specific reviewer.

reviewerEmployerUuids
boolean
Defaults to true

When true (default), the task completion is carried over to the rehire profile. When false, the task starts incomplete in the rehire profile. Ignored for I-9, W-4, Background Check, and TIN Check tasks (always start incomplete).

string
enum

How a reused task is applied on rehire. 'complete' (default when absent) copies the previous answers and marks the task complete. 'review' prefills the previous answers but leaves the task incomplete for the worker to review and submit. Only consulted when reuseInRehire is not false.

Allowed:
signedDocumentEmail
object

Email the signed PDF to the worker and these admins when a document-signing task's request is fully signed. Entries are employer uuids or supervisor / opening_owner. Document-signing tasks only.

boolean
internalTaskData
object
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json