v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified ATS API

Add result link to application

Add a result link to an application.

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.

<Note> This endpoint requires the permission **Add result links** to be enabled in [your scope config](/scopes). </Note>

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"
      }
    ]
  },
  "remote_fields": {}
}
post/ats/applications/{application_id}/result-links

Path parameters

application_idstring required

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

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

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

labelstring required

If we can display a display name for the link, we will use this label.

urlstring uri required

URL of the link.

Response

POST /ats/applications/:application_id/result-links Positive response

status'success' required
dataobject required

Example response

{
  "data": {}
}