PApaylocity
Callback

Get Callback

Changed on

🚧 Partner Restricted All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

This endpoint is used to get the details of the callback URLs configured for assessment orders. Please note, callbacks are not registered per company, as such please use B6001 as the company ID for this endpoint.

Use Cases

  • Partner would use this endpoint to view callback configuration. This will provide the details of success, error, and job creation callback URLs that have been set up
get/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback
  • Auth
    none declared. Required headers: Authorization

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns the callback details.

apiKeystring nullable

The value of the x-api-key header to utilize while executing the callback. Max length = 50. Required.

orderLevel'Assessment' | 'Test'

Indicator if assessment order is based on assessment or individual test(s). Possible values: Assessment or Test. Optional field with default value Assessment.

Changes