Skip to main content
POST
/
ats
/
applications
/
{application_id}
/
result-links
Python
from kombo import SDK


with SDK(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.ats.add_application_result_link(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",
            },
        ],
    })

    # Handle response
    print(res)
{
  "status": "success",
  "data": {},
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

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

​
application_id
string
required

The Kombo ID of the application you want to create the link for.

Body

application/json

POST /ats/applications/:application_id/result-links Request body

​
label
string
required

If we can 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/applications/:application_id/result-links Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{}
​
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.