Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Webhook Settings

Create Webhook Setting

Create a new webhook setting. Allowed types:

  • Webhooks::Settings::ApplicantSave - Fires when an applicant is created or updated
  • Webhooks::Settings::ApplicantStateChange - Fires when an applicant's application state changes
  • Webhooks::Settings::Transition - Fires when an applicant transitions between workflow stages (supports configurable strategies: first, hired, rejected, archived, all, or selected stages)
  • Webhooks::Settings::CheckrStatus - Fires when a Checkr background check status changes (clear, consider, suspended, engaged, pre_adverse, post_adverse, dispute)
  • Webhooks::Settings::OnfidoStatus - Fires when an Onfido identity verification status changes (clear, consider)
  • Webhooks::Settings::FunnelSave - Fires when an opening is created or updated
  • Webhooks::Settings::HiringGoalChange - Fires when a hiring goal is modified
  • Webhooks::Settings::PartnerStatus - Fires when a partner integration status changes
  • Webhooks::Settings::FileStatus - Fires when an uploaded file's status changes
  • Webhooks::Settings::PosthireDataCollectionApproval - Fires when post-hire documents and/or data fields are approved
  • Webhooks::Settings::PosthireWorkerActivation - Fires when a post-hire worker is activated
  • Webhooks::Settings::PosthireWorkerDeactivation - Fires when a post-hire worker is deactivated
  • Webhooks::Settings::PosthireDocumentUploaded - Fires when a document is uploaded for a post-hire worker
  • Webhooks::Settings::LocationSave - Fires when a location is created or updated
post/v2/webhook_settings

Request body

typestring required

The webhook type (see description for allowed values)

titlestring required

Title for the webhook setting

urlstring required

The HTTPS URL that will receive webhook payloads

authorization_method'no_auth' | 'simple' | 'oauth'

Authorization method

authorization_headerstring

Authorization header value (required if authorization_method is simple)

disabledboolean

Whether the webhook should be disabled

send_secure_databoolean

Whether to include secure data in webhook payloads

Response

Created