Upsert Callback

put

https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback

🚧
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.

Body Params

Callback to put.

Represents callback details and caller information for webhook execution.

callbackDetails

object

Represents callback details for webhook execution.

callerDetails

object

Represents caller details, including the caller's name.

apiKey

string | null

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

orderLevel

string

enum

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

Allowed:

Headers

testMode

boolean

If true all responses are mocked and generated randomly.

Authorization

string

required

Authorization token. Ex. Bearer ...

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No Content - Resource has been updated.

Callbacks

Language

Loading…

Choose an example:

application/json

201Created - Resource has been created.

400Bad Request - Returns the details of the error.

401Unauthorized

415Unsupported Media Type - Returns the details of the error.