Background Checks

background_check.status.updated

This event is triggered when a background check request status is updated.

postWebhookbackground_check.status.updated

Payload

background_check_idstring required

The unique identifier of the background check.

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

{
  "background_check_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
  "company_id": "ba310525-9282-40c9-8977-14d844bf891a",
  "employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6",
  "event_type": "background_check.status.updated"
}

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.