---
title: "Upsert Callback"
method: PUT
path: "/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback"
tags: ["Callback"]
---

# Upsert Callback

`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`

> 🚧 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](https://www.paylocity.com/contact/partner-form/) 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.

## Headers

- `testMode` boolean
- `Authorization` string, required

## Request body

- CallbackDto: Represents callback details and caller information for webhook execution.
  - `callbackDetails` CallbackDetailsDto: Represents callback details for webhook execution.
    - `successCallbackUrl` string, nullable: The URL to be called in case of successful execution of the webhook. Max length = 2048. Required.
    - `errorCallbackUrl` string, nullable: The URL to be called when the success callback returns an error. Max length = 2048. Optional.
    - `jobCreationCallbackUrl` string, nullable: The URL used to create and register a job with a partner. Optional URL, used only for partners that require special job validation. Max length = 2048. Optional.
  - `callerDetails` CallerDetailsDto: Represents caller details, including the caller's name.
    - `callerName` string, nullable: The name of the caller. Max length = 250. Required.
  - `apiKey` string, 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 `201`

Created - Resource has been created.

- CallbackDto: Represents callback details and caller information for webhook execution.
  - `callbackDetails` CallbackDetailsDto: Represents callback details for webhook execution.
    - `successCallbackUrl` string, nullable: The URL to be called in case of successful execution of the webhook. Max length = 2048. Required.
    - `errorCallbackUrl` string, nullable: The URL to be called when the success callback returns an error. Max length = 2048. Optional.
    - `jobCreationCallbackUrl` string, nullable: The URL used to create and register a job with a partner. Optional URL, used only for partners that require special job validation. Max length = 2048. Optional.
  - `callerDetails` CallerDetailsDto: Represents caller details, including the caller's name.
    - `callerName` string, nullable: The name of the caller. Max length = 250. Required.
  - `apiKey` string, 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.

## Other responses

- `204`: No Content - Resource has been updated.
- `400`: Bad Request - Returns the details of the error.
- `401`: Unauthorized
- `415`: Unsupported Media Type - Returns the details of the error.

## Changes

- **2026-11-03** `bf323b2134ff`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paylocity/apis/assessments-api/changes/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback/put.md)

---

[API](https://skmtc.dev/paylocity/apis/assessments-api.md) - [All operations](https://skmtc.dev/paylocity/apis/assessments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/assessments-api/revisions/bf323b2134ff?raw)