API Basics

Authentication
Errors
Filtering
Rate Limits
Webhooks

Assessments API

Assessments Overview
Callback
Order
- Update Assessment orderpatch
Package
Subscription
- Update or create a subscriptionput

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information API

Company Information
- GET a single Company Informationget
Payroll/HR
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Gets a list of employees by company IDget
- Gets a single employee by company and employee IDsget

Partner Onboarding API

Client Onboarding
- Upsert onboarding statusput

Pay Entry API

Pay Entry
- Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Deductions
Earnings

Punch Import API

Punch Import Overview
Punch Import Field Mapping
Punch Import
- Post Employee punch datapost

Retirement contributions Api

Retirement contributions
- Gets Retirement Contributionsget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Local Tax
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

API Basics

Authentication
Errors
Filtering
Rate Limits
Webhooks

Assessments API

Assessments Overview
Callback
Order
- Update Assessment orderpatch
Package
Subscription
- Update or create a subscriptionput

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information API

Company Information
- GET a single Company Informationget
Payroll/HR
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Gets a list of employees by company IDget
- Gets a single employee by company and employee IDsget

Partner Onboarding API

Client Onboarding
- Upsert onboarding statusput

Pay Entry API

Pay Entry
- Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Deductions
Earnings

Punch Import API

Punch Import Overview
Punch Import Field Mapping
Punch Import
- Post Employee punch datapost

Retirement contributions Api

Retirement contributions
- Gets Retirement Contributionsget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Local Tax
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

Add or update 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 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.

Body Params

Callback to put.

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

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

Headers

testMode

boolean

If true all responses are mocked and generated randomly.

Authorization

string

Authorization token. Ex. Bearer ...

Responses

Response body

object

inserted

boolean

Status of PUT callback operation.

requestObject

object

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

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

Assessment Test

204

No Content - Resource has been updated.

Response body

object

correlationId

string | null

value

object

code

string | null

message

string | null

stackTrace

array of strings | null

stackTrace

innerExceptionMessage

string | null

Response body

object

correlationId

string | null

value

object

code

string | null

message

string | null

stackTrace

array of strings | null

stackTrace

innerExceptionMessage

string | null

Callbacks

Updated 11 months ago

Get callback

Delete callback

Did this page help you?

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/b6001/assessmentOrders/callback \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'


xxxxxxxxxx
19
 
1
{
2
  "inserted": true,
3
  "requestObject": {
4
    "callbackDetails": {
5
      "successCallbackUrl": "string",
6
      "errorCallbackUrl": "string",
7
      "jobCreationCallbackUrl": "string",
8
      "additionalProp": {}
9
    },
10
    "callerDetails": {
11
      "callerName": "string",
12
      "additionalProp": {}
13
    },
14
    "apiKey": "string",
15
    "orderLevel": "Assessment",
16
    "additionalProp": {}
17
  },
18
  "additionalProp": {}
19
}

Updated 11 months ago

Get callback

Delete callback

Did this page help you?

API Basics
Authentication
Errors
Filtering
Rate Limits
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete callbackdelete
Add or update callbackput
Get callbackget
Order
Update Assessment orderpatch
Package
Get Assessment packagesget
Insert or update Assessment packagesput
Delete Assessment packagedelete
Insert or update Assessment packageput
Subscription
Update or create a subscriptionput

Background Check API
Background Check Overview
Client Onboarding
Updates billing code statuspatch
Delete billing codedelete
Add billing codespost
Upsert onboarding statuspost
Subscription
Deletes the webhookdelete
Register the webhook URL for the subscription of new CandidateScreeningOrderpost
Returns the webhook for the subscription of a new candidate screening orderget
Screening Package
Deletes screening packagedelete
Upserts screening packagepost
Bulk Upsertpost
Returns screening packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information API
Company Information
GET a single Company Informationget
Payroll/HR
GET a List of Pay Grades by Company IDget
GET a List of Position Codes by Company IDget
GET a List of Workers Compensation Codes by Company IDget
GET a list of Tax Codes by Company IDget
GET Pay Frequency Code by list by Company IDget
GET a list of Deduction Codes by Company IDget
GET a List of Earning Codes by Company IDget
GET a list of Cost Centers by Company IDget
GET a list of Rate Codes by Company IDget
GET a list of Work Locations by Company IDget
Job Codes
Filtering Job Codes
Delete a single Job Codedelete
Update a single Job Codeput
GET a single Job Codeget
Create a single Job Codepost
GET a list of Job Codes by Company IDget

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Gets a single employee by company and employee IDsget
Gets a list of employees by company IDget

Partner Onboarding API
Client Onboarding
Upsert onboarding statusput

Pay Entry API
Pay Entry
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Deductions
Filtering Deductions
DELETE Recurring Deduction Code on the Employee Recorddelete
Update Recurring Deduction Details for a specific past/present/future deductionput
GET Recurring Deduction Details for a specific past/present/future deductionget
GET Recurring Deduction Detailget
Create new Recurring Employee Deductionpost
GET Employee Deduction Listget
Earnings
Filtering Earnings
DELETE Recurring Earning Code on the Employee Recorddelete
Update Recurring Earning Details for a specific past/present/future earningput
GET Recurring Earning Details for a specific past/present/future earningget
GET Recurring Earning Detailget
Create new Recurring Employee Earningpost
GET Employee Earnings Listget

Punch Import API
Punch Import Overview
Punch Import Field Mapping
Punch Import
Post Employee punch datapost

Retirement contributions Api
Retirement contributions
Gets Retirement Contributionsget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Local Tax
Add Local Taxpost
Get All Local Taxesget
Delete Local Tax for Tax Codedelete
Update Local Taxput
Get Local Tax for Tax Codeget
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

API Basics
Authentication
Errors
Filtering
Rate Limits
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete callbackdelete
Add or update callbackput
Get callbackget
Order
Update Assessment orderpatch
Package
Get Assessment packagesget
Insert or update Assessment packagesput
Delete Assessment packagedelete
Insert or update Assessment packageput
Subscription
Update or create a subscriptionput

Background Check API
Background Check Overview
Client Onboarding
Updates billing code statuspatch
Delete billing codedelete
Add billing codespost
Upsert onboarding statuspost
Subscription
Deletes the webhookdelete
Register the webhook URL for the subscription of new CandidateScreeningOrderpost
Returns the webhook for the subscription of a new candidate screening orderget
Screening Package
Deletes screening packagedelete
Upserts screening packagepost
Bulk Upsertpost
Returns screening packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information API
Company Information
GET a single Company Informationget
Payroll/HR
GET a List of Pay Grades by Company IDget
GET a List of Position Codes by Company IDget
GET a List of Workers Compensation Codes by Company IDget
GET a list of Tax Codes by Company IDget
GET Pay Frequency Code by list by Company IDget
GET a list of Deduction Codes by Company IDget
GET a List of Earning Codes by Company IDget
GET a list of Cost Centers by Company IDget
GET a list of Rate Codes by Company IDget
GET a list of Work Locations by Company IDget
Job Codes
Filtering Job Codes
Delete a single Job Codedelete
Update a single Job Codeput
GET a single Job Codeget
Create a single Job Codepost
GET a list of Job Codes by Company IDget

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Gets a single employee by company and employee IDsget
Gets a list of employees by company IDget

Partner Onboarding API
Client Onboarding
Upsert onboarding statusput

Pay Entry API
Pay Entry
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Deductions
Filtering Deductions
DELETE Recurring Deduction Code on the Employee Recorddelete
Update Recurring Deduction Details for a specific past/present/future deductionput
GET Recurring Deduction Details for a specific past/present/future deductionget
GET Recurring Deduction Detailget
Create new Recurring Employee Deductionpost
GET Employee Deduction Listget
Earnings
Filtering Earnings
DELETE Recurring Earning Code on the Employee Recorddelete
Update Recurring Earning Details for a specific past/present/future earningput
GET Recurring Earning Details for a specific past/present/future earningget
GET Recurring Earning Detailget
Create new Recurring Employee Earningpost
GET Employee Earnings Listget

Punch Import API
Punch Import Overview
Punch Import Field Mapping
Punch Import
Post Employee punch datapost

Retirement contributions Api
Retirement contributions
Gets Retirement Contributionsget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Local Tax
Add Local Taxpost
Get All Local Taxesget
Delete Local Tax for Tax Codedelete
Update Local Taxput
Get Local Tax for Tax Codeget
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

201Created - Resource has been created.

400Bad Request - Returns the details of the error.

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