The Callback endpoint allows you to register callback URL(s) where you can receive the assessee information used to initiate the assessment process and submit subscription details. It allows you to read, write, and delete the callback URL when needed.

Both endpoints need to respond within 20 seconds with an HTTP status indicating the success (200) or failure (4xx or 5xx).

When you initialize the callback URLs, this is done globally, meaning that you can only register callbacks on the partner level. All companies you onboard will use the same callback URL for orders, etc.. Once you have stored a URL within our database, you can retrieve the same URL using the GET method. If you want to change that URL, call the PUT method.

The PUT endpoint contains the two payloads that Paylocity could be sending to the Partner. The callbacks are: Job Creation and Order. Please see the PUT Upsert Callback for more information on the payload for these callbacks. These can be found at the bottom of that page in a section called Callbacks that is found under the Responses section.

If call to “success” callback fails and “error” callback is provided, our API will POST an error in the format shown in the Errors section in API Basics

Assessment Order Payload

You can see the Order callback at the bottom of the PUT add or update callback endpoint.

An assessee is an individual who will go through the assessment process as part of the recruitment, onboarding, or compliance related events. Paylocity will post the assessee information for the assessment using the webhook URL registered by the assessment provider.

Paylocity is not responsible for assessee compliance nor PII. It is the sole responsibility of the assessment partner to ensure that all compliance and PII steps are completed on their side. To ensure this, Paylocity recommends that the assessment partners capture the assessees consent and the relevant PII data via their web/mobile experience. Paylocity will provide basic assessee information to the assessment partner so that you can initiate the next steps in the journey by contacting the assessee via email or redirect URL.

Callback URL: The URL registered by your company to receive the assessee information for processing the assessment request. Please see the Callbacks section at the bottom of the PUT Upsert Callback page for the order payload information.

Job Creation Payload

You can see the Job Creation callback at the bottom of the PUT add or update callback endpoint.

If a Partner requires a job title confirmation in order to score an assessment, the partner can register a job creation callback URL. In that case, Paylocity will send the job title to the partner for the partner to confirm if that title exists in their database or not. If the job title does not exist, the client will continue to try different job titles until they find one that is present in the Partner's system.