Skip to main content
POST
/
ats
/
candidates
/
{candidate_id}
/
result-links
Python
from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.ats.add_candidate_result_link(candidate_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",
            },
        ],
    })

    # Handle response
    print(res)
{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt

Use this file to discover all available pages before exploring further.

This feature is currently available for the following integrations:You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
We recommend to use add result link to application instead.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 Add result links to be enabled in your scope config.

​
Example Request Body

{
  "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"
      }
    ]
  },
  "remote_fields": {}
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
candidate_id
string
required

The Kombo ID of the candidate you want to add the result link to.

Body

application/json

POST /ats/candidates/:candidate_id/result-links Request body

​
label
string
required

If the system allows us to display a display name for the link, we will use this label.

​
url
string<uri>
required

URL of the link.

​
details
object

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.

​
remote_fields
object

Additional fields that we will pass through to specific ATS systems.

Response

POST /ats/candidates/:candidate_id/result-links Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.