# Integration Results Webhook

#### Process

It is worth noting that an exam undergoes a number of state changes during its life:

1. 1. 1. 1. Ready
            2. Incomplete
            3. Finished
            4. Review
            5. Problem
            6. Invalidated
            7. Complete
            8. Disabled

Currently webhook calls are executed at the following processing points:

- - - - When The status of the exam changes to Finished (Optional)
            - When the status of the exam changes to Completed
            - If any type of reset is executed for the exam
            - If the exam is invalidated
            - If the exam encountered a technical issue

When any of the above described events occur, a check is made the determines if the test has a tracking code assigned to it. Tracking codes are created and maintained by iTEP staff. These codes are used to identify the endpoint, authorization methods and parameters, and if a call is to be executed when the test is finished.

The call is a post call. The data in the all is a single form-encoded field named data, and the data is a JSON string that contains the results.

See [Webhook Output Sample ](https://documentation.iteponline.com/books/integration/page/webhook-output-sample "Webhook Output Sample")for an example.

##### Headers sent:

[![image.png](https://documentation.iteponline.com/uploads/images/gallery/2024-08/scaled-1680-/KBEdxAzcpCWN5Qhl-image.png)](https://documentation.iteponline.com/uploads/images/gallery/2024-08/KBEdxAzcpCWN5Qhl-image.png)

#####  Data sent:

[![image.png](https://documentation.iteponline.com/uploads/images/gallery/2024-08/scaled-1680-/7Zpnd7bjOUnZayn3-image.png)](https://documentation.iteponline.com/uploads/images/gallery/2024-08/7Zpnd7bjOUnZayn3-image.png)

<table border="1" class="align-center" id="bkmrk-important%21-note-that" style="border-collapse: collapse; width: 56.7857%; border: 5px solid rgb(224, 62, 45); height: 385.937px;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 108.984px;"><td style="border-width: 5px; border-color: rgb(224, 62, 45); height: 108.984px;">### [<span style="color: rgb(224, 62, 45);">IMPORTANT!</span>](https://documentation.iteponline.com/books/integration/page/webhook-output-sample "Webhook Output Sample")

</td></tr><tr style="height: 84.1875px;"><td class="align-left" style="border-width: 5px; border-color: rgb(224, 62, 45); height: 84.1875px;"><span style="color: rgb(0, 0, 0);">Note that there is **ONE** form encoded field named **data.**</span>

<span style="color: rgb(0, 0, 0);">The field **data** contains a JSON encoded string that, in turn, contains all of the fields sent by the result webhook.</span>

</td></tr><tr style="height: 192.766px;"><td style="border-width: 5px; border-color: rgb(224, 62, 45); height: 192.766px;">**<span style="color: red; background-color: white; font-size: 24px; overflow: visible;">Results detail such as scores and the score report URL are returned </span><span style="color: red; background-color: white; font-size: 24px;">ONLY</span><span style="color: red; background-color: white; font-size: 24px;"> when a test has passed all technical and integrity reviews and is given a completed status by the iTEP academics department.</span>**

</td></tr></tbody></table>

##### Specific Field Detail:

##### <span style="background-color: rgb(251, 238, 184);">General Fields Always included:</span>

<table border="1" class="align-center" id="bkmrk-oid-the-remote-syste" style="border-collapse: collapse; width: 75%; height: 358.36px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**OID**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the remote system unique ID for this test</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**TestID**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Duration**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">Number of minutes candidate spent taking the exam</td></tr><tr style="height: 81.1875px;"><td class="align-left" style="height: 81.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**TestDate**</td><td class="align-left" style="height: 81.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">M/D/YYYY the date the test was finished  
M will be a number between 1 and 12  
D will be a number between 1 and 31  
YYYY will be a number greater than 1900</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**TestMonth**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the month the test was finished  
**Valid values:** a number between 1 and 12</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**TestDay**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the day of the month the test was finished  
**Valid values:** a number between 1 and 31</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**TestYear**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the year the test was finished  
**Valid values:** a number greater than 1900</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**score\_report\_url**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">URL that will generate a formatted score report with skill breakdowns and explanations</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Overall\_Level**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the test as a whole  
**Valid values:** 0.0 - 6.0</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Overall\_cefr**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">Overall CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Status**</td><td style="border-width: 2px; border-color: rgb(0, 0, 0);">Exam status, as described in the previous section

</td></tr></tbody></table>

##### <span style="background-color: rgb(251, 238, 184);">Grammar Section Fields:</span>

<table border="1" class="align-center" id="bkmrk-grammar_level-the-it" style="border-collapse: collapse; width: 75%; height: 324.141px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 58.7812px;"><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">**Grammar\_Level**</td><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the grammar section

**Valid values:** 0.0 - 6.0

</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Grammar\_Score**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr style="height: 44.1875px;"><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**Grammar\_Percent**</td><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">the percent of correct answers for the grammar section  
**Valid values:** 0 - 100</td></tr><tr style="height: 47.5938px;"><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">**Grammar\_cefr**</td><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">Grammar CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr></tbody></table>

##### <span style="background-color: rgb(251, 238, 184);">Listening Section Fields:</span>

<table border="1" class="align-center" id="bkmrk-listening_level-the-" style="border-collapse: collapse; width: 75%; height: 324.141px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 58.7812px;"><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">**Listening\_Level**</td><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the Listening section

**Valid values:** 0.0 - 6.0

</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Listening\_Score**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr style="height: 44.1875px;"><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**Listening\_Percent**</td><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">the percent of correct answers for the Listening section  
**Valid values:** 0 - 100</td></tr><tr style="height: 47.5938px;"><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">**Listening\_cefr**</td><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">Listening CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr></tbody></table>

##### <span style="background-color: rgb(251, 238, 184);">Reading Section Fields:</span>

<table border="1" class="align-center" id="bkmrk-reading_level-the-it" style="border-collapse: collapse; width: 75%; height: 324.141px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 58.7812px;"><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">**Reading\_Level**</td><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the Reading section

**Valid values:** 0.0 - 6.0

</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Reading\_Score**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr style="height: 44.1875px;"><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**Reading\_Percent**</td><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">the percent of correct answers for the Reading section  
**Valid values:** 0 - 100</td></tr><tr style="height: 47.5938px;"><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">**Reading\_cefr**</td><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">Reading CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr></tbody></table>

##### <span style="background-color: rgb(251, 238, 184);">Writing Section Fields:</span>

<table border="1" class="align-center" id="bkmrk-writing_level-the-it" style="border-collapse: collapse; width: 75%; height: 324.141px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 58.7812px;"><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Level**</td><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the Writing section

**Valid values:** 0.0 - 6.0

</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Score**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr style="height: 44.1875px;"><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Percent**</td><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">the percent of correct answers for the Writing section  
**Valid values:** 0 - 100</td></tr><tr style="height: 47.5938px;"><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_cefr**</td><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">Writing CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Question\_Count**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">Number of questions in the writing section

<span style="color: rgb(224, 62, 45);">**NOTE: This is a numeric field**</span>

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Question\_1**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">As of 10/16/2024 this field will always contain a empty string

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Answer\_1**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">As of 10/16/2024 this field will always contain a empty string

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Question\_2**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">As of 10/16/2024 this field will always contain a empty string

</td></tr><tr><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">**Writing\_Answer\_2**</td><td class="align-left" style="border-width: 2px; border-color: rgb(0, 0, 0);">As of 10/16/2024 this field will always contain a empty string

</td></tr></tbody></table>

##### <span style="background-color: rgb(251, 238, 184);">Speaking Section Fields:</span>

<table border="1" class="align-center" id="bkmrk-speaking_level-the-i" style="border-collapse: collapse; width: 75%; height: 324.141px; border-width: 2px; border-color: rgb(0, 0, 0);"><colgroup><col style="width: 180px;"></col><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 58.7812px;"><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">**Speaking\_Level**</td><td class="align-left" style="height: 58.7812px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP level assigned to the Speaking section

**Valid values:** 0.0 - 6.0

</td></tr><tr style="height: 30.7969px;"><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">**Speaking\_Score**</td><td class="align-left" style="height: 30.7969px; border-width: 2px; border-color: rgb(0, 0, 0);">the iTEP Test ID</td></tr><tr style="height: 44.1875px;"><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">**Speaking\_Percent**</td><td class="align-left" style="height: 44.1875px; border-width: 2px; border-color: rgb(0, 0, 0);">the percent of correct answers for the Speaking section  
**Valid values:** 0 - 100</td></tr><tr style="height: 47.5938px;"><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">**Speaking\_cefr**</td><td class="align-left" style="height: 47.5938px; border-width: 2px; border-color: rgb(0, 0, 0);">Speaking CEFR level

See [CEFR Levels](https://documentation.iteponline.com/books/definitions/page/cefr-level "CEFR Levels") for definition

</td></tr></tbody></table>