Create Webhook for Candidate Screening Order
All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities.
Summary Description
Register the webhook URL for subscribing to new CandidateScreeningOrder events. Once registered, the partner’s webhook will receive real-time notifications whenever a new candidate order is placed.
Use Cases
-
Webhook Registration Partner provides the webhook URL for new candidate orders
-
Callback Response (below Responses section at bottom of page) When an order is placed for a candidate within a Paylocity module, the partner’s webhook will receive a callback URL response containing the order payload. This payload includes the details of the order and can be used by the partner to initiate their own workflows.
-
Example Use Case: A client places a background check order for a candidate in the Recruiting module. The partner receives the order payload through their registered webhook URL and can process the request immediately.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.