Purpose

This API endpoint provides the possibility to invite a candidate from the softgarden ATS to a test with an assessment provider.
The URL can be configured by softgarden but needs to be provided in the configuration process.

HTTP-Method

POST

Path

3rd party provider path

Authentification

Bearer Token

Request-Body

Propertylist

PropertyTypeDescription
testIdstringthe 3rd party test identifier that was provided here
candidateobjectthe candidate base data
– idstringsoftgarden application public id
– firstNamestringfirst name of the applicant
– lastNamestringlast name of the applicant
– emailstringemail of the applicant
callbackstringSoftgarden callback url that should be called
by the 3rd party provider if the assessment was updated

Example curl call

Expected response:

Propertylist

PropertyTypeDescription
invitationId (*)stringidentifier for the created invitation
testUrl (*)stringthe url for the applicant
durationnumberduration in minutes
deadlinestringdate string in ISO-8601 format UTC based
(*) field is required and need to be set

Back to the overview

Comments

Comments are closed.