API Reference
Log In
API Reference

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The webhook type (see description for allowed values)

string
required

Title for the webhook setting

string
required

The HTTPS URL that will receive webhook payloads

string
enum

Authorization method

Allowed:
string

Authorization header value (required if authorization_method is simple)

boolean

Whether the webhook should be disabled

boolean

Whether to include secure data in webhook payloads

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json