Ctrl K

Update Assessment Order

Published Oct 17, 2025

> 🚧 Partner Restricted > All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement.

Script paylocity Verified

Use in Windmill

The script

Submitted by hugo697 Bun

Verified 235 days ago

All edits

Permalink

//native
type Paylocity = {
	clientId: string
	clientSecret: string
}
/**
 * Update Assessment Order
 * > 🚧 Partner Restricted
> All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement.
 */
export async function main(
	auth: Paylocity,
	companyId: string,
	orderId: string,
	body: {
		partnerTrackingId?: string
		overallScore?: string
		overallScoreDescription?: string
		overallReports?: { name?: string; url?: string }[]
		assessments?: {
			assessmentId?: string
			assessmentStatus?: {
				updatedAt?: string
				value?:
					| 'Ordered'
					| 'WaitingOnAssessee'
					| 'InProgress'
					| 'Hold'
					| 'Complete'
					| 'CompleteReview'
					| 'RetestRecommended'
					| 'Expired'
			}
			assessmentResults?: {
				tests?: {
					id?: string
					score?: {
						value?: string
						description?: string
						attempt?: number
						reports?: { name?: string; url?: string }[]
					}
					testStatus?: {
						updatedAt?: string
						value?:
							| 'Ordered'
							| 'InProgress'
							| 'Hold'
							| 'Complete'
							| 'RetestRecommended'
							| 'Expired'
							| 'Pending'
					}
				}[]
				score?: string
				scoreDescription?: string
				reports?: { name?: string; url?: string }[]
			}
		}[]
	},
	testMode?: string
) {
	const url = new URL(
		`https://dc1prodgwext.paylocity.com/apiHub/performanceManagement/v1/companies/${companyId}/assessmentOrders/${orderId}`
	)

	const response = await fetch(url, {
		method: 'PATCH',
		headers: {
			...(testMode ? { testMode: testMode } : {}),
			'Content-Type': 'application/json',
			Authorization:
				'Bearer ' +
				(await getOAuthToken(auth, 'https://dc1prodgwext.paylocity.com/public/security/v1/token'))
		},
		body: JSON.stringify(body)
	})
	if (!response.ok) {
		const text = await response.text()
		throw new Error(`${response.status} ${text}`)
	}
	return await response.text()
}

async function getOAuthToken(auth: Paylocity, tokenUrl: string): Promise<string> {
	const params = new URLSearchParams({
		grant_type: 'client_credentials',
		client_id: auth.clientId,
		client_secret: auth.clientSecret
	})

	const response = await fetch(tokenUrl, {
		method: 'POST',
		headers: {
			Authorization: 'Basic ' + btoa(`${auth.clientId}:${auth.clientSecret}`),
			'Content-Type': 'application/x-www-form-urlencoded'
		},
		body: params.toString()
	})

	if (!response.ok) {
		const text = await response.text()
		throw new Error(`OAuth token request failed: ${response.status} ${text}`)
	}

	const data = await response.json()
	return data.access_token
}


`1`	`//native`
`2`	`type Paylocity = {`
`3`	`clientId: string`
`4`	`clientSecret: string`
`5`	`}`
`6`	`/**`
`7`	`* Update Assessment Order`
`8`	`* > 🚧 Partner Restricted`
`9`	`> All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement.`
`10`	`*/`
`11`	`export async function main(`
`12`	`auth: Paylocity,`
`13`	`companyId: string,`
`14`	`orderId: string,`
`15`	`body: {`
`16`	`partnerTrackingId?: string`
`17`	`overallScore?: string`
`18`	`overallScoreDescription?: string`
`19`	`overallReports?: { name?: string; url?: string }[]`
`20`	`assessments?: {`
`21`	`assessmentId?: string`
`22`	`assessmentStatus?: {`
`23`	`updatedAt?: string`
`24`	`value?:`
`25`	`\| 'Ordered'`
`26`	`\| 'WaitingOnAssessee'`
`27`	`\| 'InProgress'`
`28`	`\| 'Hold'`
`29`	`\| 'Complete'`
`30`	`\| 'CompleteReview'`
`31`	`\| 'RetestRecommended'`
`32`	`\| 'Expired'`
`33`	`}`
`34`	`assessmentResults?: {`
`35`	`tests?: {`
`36`	`id?: string`
`37`	`score?: {`
`38`	`value?: string`
`39`	`description?: string`
`40`	`attempt?: number`
`41`	`reports?: { name?: string; url?: string }[]`
`42`	`}`
`43`	`testStatus?: {`
`44`	`updatedAt?: string`
`45`	`value?:`
`46`	`\| 'Ordered'`
`47`	`\| 'InProgress'`
`48`	`\| 'Hold'`
`49`	`\| 'Complete'`
`50`	`\| 'RetestRecommended'`
`51`	`\| 'Expired'`
`52`	`\| 'Pending'`
`53`	`}`
`54`	`}[]`
`55`	`score?: string`
`56`	`scoreDescription?: string`
`57`	`reports?: { name?: string; url?: string }[]`
`58`	`}`
`59`	`}[]`
`60`	`},`
`61`	`testMode?: string`
`62`	`) {`
`63`	`const url = new URL(`
`64`	`https://dc1prodgwext.paylocity.com/apiHub/performanceManagement/v1/companies/${companyId}/assessmentOrders/${orderId}`
`65`	`)`
`66`
`67`	`const response = await fetch(url, {`
`68`	`method: 'PATCH',`
`69`	`headers: {`
`70`	`...(testMode ? { testMode: testMode } : {}),`
`71`	`'Content-Type': 'application/json',`
`72`	`Authorization:`
`73`	`'Bearer ' +`
`74`	`(await getOAuthToken(auth, 'https://dc1prodgwext.paylocity.com/public/security/v1/token'))`
`75`	`},`
`76`	`body: JSON.stringify(body)`
`77`	`})`
`78`	`if (!response.ok) {`
`79`	`const text = await response.text()`
`80`	throw new Error(`${response.status} ${text}`)
`81`	`}`
`82`	`return await response.text()`
`83`	`}`
`84`
`85`	`async function getOAuthToken(auth: Paylocity, tokenUrl: string): Promise<string> {`
`86`	`const params = new URLSearchParams({`
`87`	`grant_type: 'client_credentials',`
`88`	`client_id: auth.clientId,`
`89`	`client_secret: auth.clientSecret`
`90`	`})`
`91`
`92`	`const response = await fetch(tokenUrl, {`
`93`	`method: 'POST',`
`94`	`headers: {`
`95`	Authorization: 'Basic ' + btoa(`${auth.clientId}:${auth.clientSecret}`),
`96`	`'Content-Type': 'application/x-www-form-urlencoded'`
`97`	`},`
`98`	`body: params.toString()`
`99`	`})`
`100`
`101`	`if (!response.ok) {`
`102`	`const text = await response.text()`
`103`	throw new Error(`OAuth token request failed: ${response.status} ${text}`)
`104`	`}`
`105`
`106`	`const data = await response.json()`
`107`	`return data.access_token`
`108`	`}`
`109`