Skip to navigation
Assessments Callback

Upsert Callback

View as Markdown
Partner Restricted

All assessment API endpoints are restricted to assessment 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

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

Headers

testModestringOptional
If true all responses are mocked and generated randomly.
AcceptstringOptional

Media type(s) the client can accept in the response (typically application/json).

Request

Request payload for this operation. See the official endpoint documentation for required fields and allowable values.

Response

Successful response

Errors

401
Unauthorized Error