Contract documents

contract_document.status.changed

This webhook is triggered whenever a contract document's status changes, including initial creation.

postWebhookcontract_document.status.changed

Payload

company_idstring required

The id of the company that owns the employment

contract_document_idstring required

The id of the contract document

employment_idstring nullable required

The id of the employment associated with the contract document. Null when the contract document is not associated with an employment.

event_typestring required

The webhook event type identifier.

Example payload

{
  "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59",
  "contract_document_id": "97e04d61-0a6d-4c4f-9299-c08d1eeaba20",
  "employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6",
  "event_type": "contract_document.status.changed"
}

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.