Employments

employment.employment_agreement.available

This event is triggered when an employment agreement is available for a user

postWebhookemployment.employment_agreement.available

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.

file_idstring required

The unique identifier of the related file.

Example payload

{
  "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59",
  "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
  "event_type": "employment.employment_agreement.available",
  "file_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
}

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.