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 (requires strategy; see the parameter description)
  • 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. The funnel_save payload includes listing_status on accounts running the four-state sourcing model.
  • Webhooks::Settings::FunnelSourcingStatusChange - Accepted only on accounts running the four-state sourcing model. Fires for every sourcing status change after creation, including automatic changes. Never fires on create or when the status is unchanged.
  • Webhooks::Settings::HiringGoalChange - Fires when a hiring goal is modified
  • Webhooks::Settings::PartnerStatus - Fires when a partner integration status changes, and when a First Advantage background-check result or score changes without one
  • 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

Sourcing status change payload

The funnel_sourcing_status_change event captures each status change and is delivered only after its transaction commits. Its JSON body contains:

  • funnel_id: the opening's external ID.
  • old_status and new_status: the sourcing statuses before and after the change (public, internal, not_posted, or intake_closed).
  • listing_status_trigger: the source of the change, such as api or internal_window, or null when unavailable.
  • user: { "id": "<user external id>" } when a user is attributed to the change, or null otherwise.
  • reason: the recorded reason, such as api, activation_default, deactivation_default, internal_window, or unknown.
  • webhook_call_sequence: an integer that increases with committed changes to the opening.

Deliveries can arrive out of order or be retried. Receivers must retain the highest webhook_call_sequence per funnel_id and ignore deliveries with an equal or lower sequence.

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

string
enum

Required for Webhooks::Settings::Transition: which stage transitions fire the webhook. Ignored for other types

Allowed:
stage_ids
array of strings

Stage IDs to fire on; required when strategy is selected_stages. Webhooks::Settings::Transition only

stage_ids
boolean

Whether to send a minimal payload. Webhooks::Settings::Transition only

Responses

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