Add result link to application
curl --request POST \
--url https://api.kombo.dev/v1/ats/applications/{application_id}/result-links \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{
"label": "Assessment Result",
"url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG",
"details": {
"custom_field_name_prefix": "Acme:",
"attributes": [
{
"key": "Score",
"value": "100%"
},
{
"key": "Time",
"value": "2:30h"
}
]
}
}'
{
"status": "success",
"data": {}
}
This can, for example, be used to link a candidate back to a test result/assessment in your application. As not all ATS tools have a “result link” feature, we sometimes repurpose other fields to expose it.
This endpoint requires the permission Create and manage candidates and applications to be enabled in your scope config.
Example Request Body
{
"application_id": "8Xi6iZrwusZqJmDGXs49GBmJ",
"label": "Assessment Result",
"url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG",
"details": {
"custom_field_name_prefix": "Acme:",
"attributes": [
{
"key": "Score",
"value": "100%"
},
{
"key": "Time",
"value": "2:30h"
}
]
}
}
Authorizations
Create an API key on the Secrets page in the Kombo dashboard.
Headers
ID of the integration you want to interact with.
Path Parameters
Kombo ID of the application you want to create the link for.
Body
If we can display a display name for the link, we will use this label.
URL of the link.
Additional details with attributes that will be added to the result. This can be percentages, scores, or any text.
We generally recommend using short attribute keys and a short custom_field_name_prefix to avoid overflowing the ATS UI.
Additional fields that we will pass through to specific ATS systems.
Response
success
curl --request POST \
--url https://api.kombo.dev/v1/ats/applications/{application_id}/result-links \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{
"label": "Assessment Result",
"url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG",
"details": {
"custom_field_name_prefix": "Acme:",
"attributes": [
{
"key": "Score",
"value": "100%"
},
{
"key": "Time",
"value": "2:30h"
}
]
}
}'
{
"status": "success",
"data": {}
}