Update order result

Python

from kombo import Kombo
from kombo.utils import parse_datetime


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

    res = k_client.assessment.update_order_result(assessment_order_id="GRKdd9dibYKKCrmGRSMJf3wu", status="COMPLETED", result_url="https://example.com", completed_at=parse_datetime("2023-04-04T00:00:00Z"), score=90, max_score=100, attributes=[
        {
            "type": "TEXT",
            "label": "Role fit",
            "value": "Excellent",
        },
        {
            "type": "SUB_RESULT",
            "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
            "label": "Personality test",
            "score": {
                "value": 97,
                "max": 100,
            },
            "status": "COMPLETED",
        },
    ], attachments=[
        {
            "name": "Assessment Report.pdf",
            "content_type": "application/pdf",
            "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
        },
    ])

    # Handle response
    print(res)

{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}

PUT

assessment

orders

{assessment_order_id}

result

Python

from kombo import Kombo
from kombo.utils import parse_datetime


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

    res = k_client.assessment.update_order_result(assessment_order_id="GRKdd9dibYKKCrmGRSMJf3wu", status="COMPLETED", result_url="https://example.com", completed_at=parse_datetime("2023-04-04T00:00:00Z"), score=90, max_score=100, attributes=[
        {
            "type": "TEXT",
            "label": "Role fit",
            "value": "Excellent",
        },
        {
            "type": "SUB_RESULT",
            "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
            "label": "Personality test",
            "score": {
                "value": 97,
                "max": 100,
            },
            "status": "COMPLETED",
        },
    ], attachments=[
        {
            "name": "Assessment Report.pdf",
            "content_type": "application/pdf",
            "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
        },
    ])

    # Handle response
    print(res)

{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}

Supported integrations

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.

Example Request Body

{
  "status": "COMPLETED",
  "score": 90,
  "max_score": 100,
  "result_url": "https://example.com",
  "completed_at": "2023-04-04T00:00:00.000Z",
  "attributes": [
    {
      "type": "TEXT",
      "label": "Role fit",
      "value": "Excellent"
    },
    {
      "type": "SUB_RESULT",
      "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
      "label": "Personality test",
      "score": {
        "value": 97,
        "max": 100
      },
      "status": "COMPLETED"
    }
  ],
  "attachments": [
    {
      "name": "Assessment Report.pdf",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "content_type": "application/pdf"
    }
  ]
}

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

assessment_order_id

string

required

PUT /assessment/orders/:assessment_order_id/result Parameter

Body

application/json

PUT /assessment/orders/:assessment_order_id/result Request body

status

enum<string>

required

Status of the assessment.

Please note the status can only be updated to a different value if its current value is OPEN.

Available options:

COMPLETED,

CANCELLED,

OPEN

result_url

string<uri>

required

completed_at

string<date-time>

YYYY-MM-DDTHH:mm:ss.sssZ

Please make sure this value is provided when the status is of the type COMPLETED or CANCELLED.

score

number<double>

Required range: x >= -1.7976931348623157e+308

max_score

number<double>

Required range: x >= -1.7976931348623157e+308

attributes

object[]

An array of additional attributes that you would like to submit as a part of the assessment result.

If an ATS only supports writing text attributes, we will transform non TEXT attributes into formatted plain text values.

Option 1
Option 2

Show child attributes

attributes.type

string

required

Allowed value: "TEXT"

attributes.label

string

required

attributes.value

string

required

attachments

object[]

An array of attachments containing the assessment result.

Maximum array length: 5

Show child attributes

attachments.name

string

required

File name of the file you want to upload. We recommend providing something human-readable with a valid file extension (like Resume.pdf), as this might be shown in your customer's system.

attachments.content_type

string

Content/MIME type of the file (e.g., application/pdf).

If you provide data, this is required. If you provide data_url, this is optional and we'll attempt to use the Content-Type header of the response.

Note: Please validate that the content type you provide is actually meaningful (and not something generic like application/octet-stream). Especially when using object storage (like AWS S3), it's easy to accidentally discard the content types of user-provided files, so make sure to explicitly persist them when processing uploads from your users (see guides for AWS, Google Cloud, and Azure).

attachments.data_url

string<uri>

URL to the file you want to upload that can be accessed without authentication headers. We will download the content immediately when receiving the request, so the URL can be short-lived.

If you're using an object storage provider (like AWS S3), we strongly recommend providing a signed URL for secure access (see guides for AWS, Google Cloud, and Azure).

Note: You must provide either this or data_url. We recommend data_url over data for most cases.

attachments.data

string

Base64-encoded contents of the file you want to upload.

Note: You must provide either this or data_url. We recommend data_url over data for most cases.

remote_fields

object

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

Show child attributes

remote_fields.smartrecruiters

object

Show child attributes

remote_fields.smartrecruiters.scoreLabel

string

Value that we will pass through to SmartRecruiters' scoreLabel field.

Response

PUT /assessment/orders/:assessment_order_id/result 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.

Show child attributes

warnings.message

string

required

Get open orders Create connection link

⌘I

General

Features

Guides

ATS Assessment API Reference

General API Reference

Update order result

Example Request Body

Authorizations

Headers

Path Parameters

Body

Response

General

Features

Guides

ATS Assessment API Reference

General API Reference

​Example Request Body

Authorizations

Headers

Path Parameters

Body

Response

Example Request Body