SG Developers Invite candidate to a test
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
|
1 2 3 4 5 6 7 8 9 10 |
{ "testId": "123456789", "candidate": { "id": "ff6f133b-bd29-4b4e-b141-132b8acdd759", "firstName": "John", "lastName": "Doe", "email": "john.doe@somewhere.com" }, "callback": "https://softgarden.de/callbackurl" } |
Propertylist
| Property | Type | Description |
| testId | string | the 3rd party test identifier that was provided here |
| candidate | object | the candidate base data |
| – id | string | softgarden application public id |
| – firstName | string | first name of the applicant |
| – lastName | string | last name of the applicant |
| string | email of the applicant | |
| callback | string | Softgarden callback url that should be called by the 3rd party provider if the assessment was updated |
Example curl call
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
curl --location --request POST '[3rd party api endpoint for invitation creation]' \ --header 'Authorization: Bearer [token]' \ --header 'Content-Type: application/json' \ --data-raw '{ "testId": "123456789", "candidate": { "id": "ff6f133b-bd29-4b4e-b141-132b8acdd759", "firstName": "John", "lastName": "Doe", "email": "john.doe@somewhere.com" }, "callback": "https://softgarden.de/callbackurl" }' |
Expected response:
|
1 2 3 4 5 6 |
{ "invitationId": "some-invitation-id", "testUrl": "https://some-test-url.de/assessment", "duration": 60, "deadline": "2021-03-26T10:00:00Z" } |
Propertylist
| Property | Type | Description |
| invitationId (*) | string | identifier for the created invitation |
| testUrl (*) | string | the url for the applicant |
| duration | number | duration in minutes |
| deadline | string | date string in ISO-8601 format UTC based |