GuidesRecipesAPI ReferenceChangelog
Login
API Reference
Login

Create Webhook for Candidate Screening Order

post
https://dc1demogwext.paylocity.com/compliance/v1/companies/b6001/backgroundCheck/candidateScreeningOrders/subscription
🚧

Partner Restricted

All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to [email protected] if you would like to discuss partnership opportunities.

Summary Description

Register the webhook URL for the subscription of new CandidateScreeningOrder

Use Cases

  • Partner provides the webhook URL for new candidate orders
Body Params

The callback information

string | null

Optional. The value of the x-api-key header to utilize while executing the callback.
Allowable Values:
50 char max

callbackDetails
object

Callback Details

callerDetails
object
Headers
boolean

If true all responses are mocked and generated randomly

Responses

401

Unauthorized

Callback

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Choose an example:
application/json

Updated 6 months ago

Did this page help you?