PApaylocity
Callback

Upsert 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 configure callback URLs for assessment order notifications for the Partner.

Use Cases

  • Customizable Endpoints: The Partner would use this to provide a general endpoint for all Paylocity clients by specifying b6001.
  • Notification Management: The Partner would use this endpoint to receive notifications about new orders, errors, and job creation events.
put/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 ...

Request body

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.

Response

Created - Resource has been created.

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