Employment Management

employment.onboarding_task.completed

This event is triggered everytime an employment onboarding task (Personal profile, Administrative details, Emergency contact, Supporting documentation, etc) is completed by an employee during the self-enrollment.

postWebhookemployment.onboarding_task.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": "97c7ce7e-ca67-11ed-bce5-3bb70cbb9f9e",
  "completed_task": {
    "action": "administrative_details",
    "completed_at": "2023-03-23T03:21:23Z",
    "description": "description for administrative details",
    "name": "Administrative details",
    "required": true,
    "status": "completed"
  },
  "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
  "event_type": "employment.onboarding_task.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.