Employment Management

employment.onboarding.completed

This event is triggered when an employment onboarding is completed and the employment is set to active.

An onboarding is considered complete when the employee finishes their self-enrollment and has completed all the onboarding tasks assigned to them (Personal profile, Administrative details, Emergency contact, Supporting documentation, etc).

postWebhookemployment.onboarding.completed

Payload

company_idstring required

The unique identifier of the related company.

employment_idstring required

The unique identifier of the related employment.

event_typestring required

The webhook event type identifier.

Example payload

{
  "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59",
  "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
  "event_type": "employment.onboarding.completed"
}

Response

Any 200 response confirms that the webhook was delivered.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.