Employments

employment.onboarding.cancelled

This event is triggered when an employment onboarding is cancelled.

postWebhookemployment.onboarding.cancelled

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": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f",
  "event_type": "employment.onboarding.cancelled"
}

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.