Worky Developers

Overview

Worky's onboarding flow allows you to send a secure link to new employees so they can fill out their own profile, upload documents (ID, proof of address), and signing their contract digitally.

1. Send Onboarding Invitation

Create an invitation. The employee will receive an email with a unique secure link.

POST/api/v1/hr/onboarding-invitees

Request Body

{
  "email": "[email protected]",
  "firstName": "Ana",
  "lastName": "Silva",
  "jobPositionId": "jp-456",
  "startDate": "2024-04-01",
  "contractType": "INDEFINITE",
  "workModality": "HYBRID"
}

2. Track Progress

Monitor the status of onboarding invitations to see who has completed their forms.

GET/api/v1/hr/onboarding-invitees

3. Complete Onboarding

Once the employee submits their data, you can review and approve it. Upon approval, an Employee record is created in the Directory.

POST/api/v1/hr/onboarding-invitees/{id}/complete

Webhook Event: You can subscribe to the employee.created webhook to be notified when onboarding is finalized.