![](\"/images/logo.png\"){kind=logo}
"
31 | },
32 | "devDependencies": {
33 | "prettier": "^2.8.4"
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/docs/index.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | padding: 0;
4 | font-family: 'Work Sans', sans-serif;
5 | color: #33485f;
6 | font-size: 1em;
7 | line-height: 1.8;
8 | }
9 |
10 | h1, h2, h3 {
11 | line-height: 1.25;
12 | margin: 0;
13 | }
14 |
15 | h1 {
16 | font-size: 1.75em;
17 | }
18 |
19 | h2 {
20 | font-size: 1.5em;
21 | }
22 |
23 | h3 {
24 | font-size: 1.25em;
25 | }
26 |
27 | .page-container {
28 | height: 100vh;
29 | background-color: #002570;
30 | display: flex;
31 | flex-direction: column;
32 | align-items: center;
33 | }
34 |
35 | .page-body {
36 | height: 100vh;
37 | width: 1024px;
38 | max-width: 1024px;
39 | background-color: #f5f6f7;
40 | }
41 |
42 | .logo-link {
43 | display: inline-block;
44 | }
45 |
46 | .header {
47 | font-family: 'JetBrains Mono', monospace;
48 | }
49 |
50 | .header-title {
51 | text-align: center;
52 | }
53 |
54 | .header-subtitle {
55 | font-size: 1em;
56 | text-align: center;
57 | }
58 |
59 | .main-content {
60 | height: 100%;
61 | display: flex;
62 | flex-direction: column;
63 | align-items: center;
64 | justify-content: center;
65 | }
66 |
67 | .main-content > *:not(:first-child) {
68 | margin-top: 32px;
69 | }
70 |
71 | .doc-link {
72 | font-size: 1.3em;
73 | display: block;
74 | font-family: 'JetBrains Mono', monospace;
75 | }
76 |
--------------------------------------------------------------------------------
/docs/graphql/index.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | padding: 0;
4 | font-family: 'Work Sans', sans-serif;
5 | color: #33485f;
6 | font-size: 1em;
7 | line-height: 1.8;
8 | }
9 |
10 | h1, h2, h3 {
11 | line-height: 1.25;
12 | margin: 0;
13 | }
14 |
15 | h1 {
16 | font-size: 1.75em;
17 | }
18 |
19 | h2 {
20 | font-size: 1.5em;
21 | }
22 |
23 | h3 {
24 | font-size: 1.25em;
25 | }
26 |
27 | pre {
28 | white-space: pre-wrap;
29 | padding: 16px;
30 | color: #21cf82;
31 | background-color: black;
32 | }
33 |
34 | pre > code {
35 | font-family: 'JetBrains Mono', monospace;
36 | }
37 |
38 | .mono {
39 | font-family: 'JetBrains Mono', monospace;
40 | }
41 |
42 | .page-container {
43 | background-color: #002570;
44 | display: flex;
45 | flex-direction: column;
46 | align-items: center;
47 | }
48 |
49 | .page-body {
50 | max-width: 1024px;
51 | background-color: #f5f6f7;
52 | }
53 |
54 | .header {
55 | display: flex;
56 | flex-direction: row;
57 | justify-content: start;
58 | padding: 16px 16px 32px;
59 | }
60 |
61 | .main-content {
62 | padding: 0 48px 16px 48px;
63 | }
64 |
65 | .section {
66 | margin-top: 40px;
67 | }
68 |
69 | .section > h2 {
70 | padding-bottom: 24px;
71 | }
72 |
73 | .subsection {
74 | margin-bottom: 24px;
75 | }
76 |
77 | .doc-link {
78 | font-size: 1.3em;
79 | display: block;
80 | }
81 |
82 | .schema-link {
83 | margin-top: 8px;
84 | padding-left: 16px;
85 | }
--------------------------------------------------------------------------------
/docs/webhooks/index.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | padding: 0;
4 | font-family: 'Work Sans', sans-serif;
5 | color: #33485f;
6 | font-size: 1em;
7 | line-height: 1.8;
8 | }
9 |
10 | h1,
11 | h2,
12 | h3 {
13 | line-height: 1.25;
14 | margin: 0;
15 | }
16 |
17 | h1 {
18 | font-size: 1.75em;
19 | }
20 |
21 | h2 {
22 | font-size: 1.5em;
23 | }
24 |
25 | h3 {
26 | font-size: 1.25em;
27 | }
28 |
29 | table {
30 | width: 100%;
31 | }
32 |
33 | pre {
34 | white-space: pre-wrap;
35 | padding: 16px;
36 | color: #21cf82;
37 | background-color: black;
38 | }
39 |
40 | pre > code {
41 | font-family: 'JetBrains Mono', monospace;
42 | }
43 |
44 | li:not(:first-child) {
45 | margin-top: 12px;
46 | }
47 |
48 | .mono {
49 | font-family: 'JetBrains Mono', monospace;
50 | }
51 |
52 | .page-container {
53 | background-color: #002570;
54 | display: flex;
55 | flex-direction: column;
56 | align-items: center;
57 | }
58 |
59 | .page-body {
60 | max-width: 1024px;
61 | background-color: #f5f6f7;
62 | }
63 |
64 | .header {
65 | display: flex;
66 | flex-direction: row;
67 | justify-content: start;
68 | padding: 16px 16px 32px;
69 | }
70 |
71 | .main-content {
72 | padding: 0 48px 16px 48px;
73 | }
74 |
75 | .section {
76 | margin-top: 40px;
77 | }
78 |
79 | .section > h2 {
80 | padding-bottom: 24px;
81 | }
82 |
83 | .subsection {
84 | margin-bottom: 24px;
85 | }
86 |
87 | .footer {
88 | margin-bottom: 16px;
89 | margin-left: 48px;
90 | }
91 |
92 | .doc-link {
93 | font-size: 1.3em;
94 | display: block;
95 | }
96 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | 
21 |
22 |
20 |
21 | 30 | GraphQL is an API query language, originally created by Facebook as an alternative to REST. 31 | If you're new to GraphQL, the best place to start is the official documentation. 32 |
33 |37 | It depends on what kind of environment you are making the query from. 38 | Check out this list of GraphQL client libraries to see some tools already available in multiple languages, 39 | including C#/.NET, Go, Java, JavaScript, and Python. These client libraries can make writing queries easier and may provide built-in support for features like caching. 40 |
41 |42 | However, GraphQL is just a query language served over HTTP, so you can also make a request without using any GraphQL-specific libraries or packages. 43 | Here's an example using cURL (you'd need to replace the API key and test ID to try it yourself): 44 |
45 |curl 'https://app.codesignal.com/graphql' -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer MY_API_KEY' --data-binary '{"query":"{ companyTest(id: \"MY_TEST_ID\") { title } }"}'This returns data that looks like this:
47 |{"data":{"companyTest":{"title":"My Company Test"}}}52 | Although you'll likely want to consume our API programmatically using a library in your language of choice, 53 | as you work on your integration, you may find it helpful to have a readily available UI for writing and running queries. 54 | For that, try out our GraphQL Playground, which is connected to our real API 55 | and provides a helpful interface that will make it easier for you to quickly spot and resolve syntax or schema issues in your queries. 56 |
57 |58 | To use the GraphQL Playground, you need to first generate an API key (see below) and then provide that in the HTTP Headers section in the bottom-left: 59 |
60 |{ "Authorization": "Bearer YOUR_API_KEY" }62 | As long as you provide a valid API key, you can write and execute queries here and see the result immediately. If there are errors in your query syntax, 63 | red highlighting will appear on the left side of lines with errors, and you can hover over the query to learn more about what is wrong. 64 |
65 |66 | You can also explore the GraphQL schema and documentation live from the GraphQL Playground, as well as copy your query to a cURL command like the one from the previous section. 67 |
68 |72 | Take a look at our schema. All read-only queries can be found under RootQuery, and all mutations can be found under RootMutation. 73 |
74 |75 | Here's an example of a query that you could run to fetch the answers from a company test session: 76 |
77 |query AnswerQuery {
78 | companyTestSession(id: "MY_TEST_SESSION_ID") {
79 | id
80 | result {
81 | taskResults {
82 | solution {
83 | id
84 | ... on CodingSolution {
85 | sources {
86 | source
87 | language
88 | path
89 | }
90 | }
91 | ... on FreeFormSolution {
92 | freeTextAnswer: answer
93 | }
94 | ... on QuizSolution {
95 | quizAnswer: answer
96 | }
97 | }
98 | }
99 | }
100 | }
101 | }103 | In this case, we're using the graph-based nature of the API to make the following request: 104 | Look up a given company test session. For that session, return the ID and the result. 105 | For the result, return the result for each task, including the solution. For each solution, 106 | return the ID of the solution and more information depending on what 107 | kind of solution it is (using inline fragment syntax 108 | to query different fields based on type, and aliases 109 | to make sure the "answer" field does not conflict, since it has different types for free-text and quiz answers. 110 |
111 |112 | That might return something that looks like this: 113 |
114 |{
115 | "data": {
116 | "companyTestSession": {
117 | "id": "MY_TEST_SESSION_ID",
118 | "result": {
119 | "taskResults": [
120 | {
121 | "solution": {
122 | "id": "MY_CODING_SOLUTION_ID",
123 | "sources": [
124 | {
125 | "source": "console.log('hello world');",
126 | "language": "js",
127 | "path": "main.js"
128 | }
129 | ]
130 | },
131 | },
132 | {
133 | "solution": {
134 | "id": "MY_FREE_TEXT_SOLUTION_ID",
135 | "freeTextAnswer": "Hello, world!",
136 | },
137 | },
138 | {
139 | "solution": {
140 | "id": "MY_QUIZ_SOLUTION_ID",
141 | "quizAnswer": [
142 | "All of the above"
143 | ]
144 | },
145 | }
146 | ]
147 | }
148 | }
149 | }
150 | }158 | If you're not already using CodeSignal, start a conversation with us by requesting a demo. 159 |
160 |161 | If you're an existing customer, reach out to support@codesignal.com to learn more. 162 |
163 |167 | When making a GraphQL request, pass an "Authorization" header with a value of "Bearer YOUR_API_KEY" with the HTTP request. 168 | You can see a simple example of this in the cURL command above. 169 |
170 |171 | Some queries or mutations may require specific permissions to be assigned to your API key. 172 | If you receive Access Denied errors that you believe to be in error, please contact support. 173 |
174 |181 | Let's start with an analogy: Say you (the API consumer) are at home, ordering groceries (data) through a service like Instacart (the API). 182 |
183 |184 | A REST API is like a shopper who can only buy one item from the grocery store at a time. 185 | They can get any item in the store, but only one; if you want a second item, they have to make another full round-trip. 186 | For this kind of API, the main limit is a "rate limit." In other words, how frequently can you ask the shopper to go to the store? 187 |
188 |189 | On the other hand, GraphQL APIs are like shoppers who can buy a whole cart's worth of goods. Convenient! 190 | Like REST API shoppers, they may also have a limit on how frequently they can go to the store (a rate limit), 191 | but they can bring back a lot more groceries per trip. However, if you order too many things at once, 192 | they won't all fit in the shopping cart. The size of the shopping cart is the "maximum cost" allowed per trip. 193 |
194 |198 | Our rate limits vary based on the query or mutation; specific limits can be found in the schema documentation. Common values are 10 requests per second, 199 | or 5 requests per second. 200 |
201 |202 | Our maximum cost for a single query is 10000, and additionally we also don't allow queries with a depth greater than 10. 203 |
204 |205 | The cost of each resource can be found in the schema documentation, either as a scalar number or a multiplier based on the input. 206 | The total cost of a query will be determined by the cumulative cost of each queried resource. 207 |
208 |
22 |
23 | 95 | A webhook is a way to receive an event notification from a server. When certain 96 | events occur in CodeSignal, a JSON payload containing information about the event 97 | will be sent via an HTTP POST request to a specified endpoint URL. 98 |
99 |139 | If you're not already using CodeSignal, 140 | start a conversation with us by 141 | requesting a demo. 142 |
143 |
162 | 
172 | 
180 | 
188 | 199 | For webhooks with a secret key, CodeSignal will sign every request with a 200 | X-CodeSignal-Signature HTTP header, generated using the 201 | following algorithm: 202 |
203 |getSignature(secretKey, endpointUrl, { eventType = '', triggeredOn = '' }) {
204 | const plainText = `${endpointUrl}${eventType}${triggeredOn}`;
205 | const hash = crypto.createHmac('sha256', secretKey);
206 | hash.update(plainText);
207 | return hash.digest('hex');
208 | }210 | Here, triggeredOn is the timestamp present in every event 211 | payload. 212 |
213 |217 | For each webhook, we store a list of events the hook should be notified about. When 218 | events have been triggered, CodeSignal sends webhooks one event at a time, at a rate 219 | of about one per second. If a web hook needs to be notified about multiple events, 220 | events are guaranteed to be sent in the order they were triggered. 221 |
222 |227 | If CodeSignal receives any response other than a 200 OK from the endpoint, 228 | the endpoint will be marked unhealthy, and CodeSignal will attempt to resend the 229 | event after a delay (up to 25 attempts total). 230 |
231 |232 | CodeSignal is looking for a 200 OK response from the endpoint URL in order to continue processing 233 | further events. Do not return 400 errors; they will not be respected and the webhook 234 | will be flagged as unhealthy. Instead, keep error-handling logic internal to your endpoint. 235 |
236 |237 | The delay is calculated using an exponential backoff strategy. In other words, 238 | the retry window will be short at first but will increase if the endpoint keeps failing. 239 | The delay between each failure and the next attempt is calculated with the formula below. 240 |
241 |secondsToWait = (failCount - 1)^4 + 15 + (random(30) * failCount)244 | Assuming that random(30) always returns its average of 15, 245 | that would lead to the following retry attempts. (Not all retries are listed in the 246 | table, since this is just meant to give a sense of the retry backoff timeline.) 247 |
248 || Total failed attempts | 252 |Time until next attempt | 253 |Time until next attempt, from first failure | 254 |
|---|---|---|
| 1 | 259 |30 seconds | 260 |30 seconds | 261 |
| 2 | 264 |46 seconds | 265 |1.3 minutes | 266 |
| 3 | 269 |1.2 minutes | 270 |2.5 minutes | 271 |
| 4 | 274 |2.6 minutes | 275 |5.1 minutes | 276 |
| 6 | 279 |12.2 minutes | 280 |23 minutes | 281 |
| 11 | 284 |2.8 hours | 285 |7.4 hours | 286 |
| 14 | 289 |8 hours | 290 |1 day | 291 |
| 16 | 294 |14 hours | 295 |2.1 days | 296 |
| 24 | 299 |3.2 days | 300 |16.6 days | 301 |
| 25 | 304 |n/a | 305 |n/a | 306 |
310 | After the first few retries CodeSignal will also send an email notification to the 311 | owner emails associated with the webhook, if any. To make sure we don't spam you, 312 | CodeSignal will only send emails for each webhook after the 5th failure, the 14th failure, 313 | and every failure starting from the 16th. 314 |
315 |316 | When a webhook is unhealthy, events will be queued in the order they were triggered, 317 | and the queue will not be flushed until the first event in the queue can be 318 | processed successfully (by receiving a 200 OK response from the endpoint URL). If 319 | you are able to identify and resolve the issue with the endpoint URL, you can open 320 | the webhook settings modal, then test and save the fixed webhook in order to mark it 321 | as healthy again. Once it is marked as healthy, the webhook will immediately flush 322 | its queue of pending events. 323 |
324 |325 | After 25 consecutive failed delivery attempts, the webhook will be disabled and the 326 | events queue will be cleared. You can re-enable the webhook after updating the endpoint 327 | to return a valid 200 OK response. 328 |
329 |352 | Here is an overview of the end to end workflow of events for CodeSignal Assessments. 353 |
354 |
360 | 
369 | Fired when a new assessment is created.
373 |{
375 | event: 'assessmentCreated',
376 | triggeredOn: number,
377 | payload: {
378 | assessmentId: string,
379 | assessmentTitle: string,
380 | assessmentStatus: 'active' | 'archived' | 'deleted'
381 | }
382 | };{
385 | event: 'assessmentCreated',
386 | triggeredOn: 1553720789347,
387 | payload: {
388 | assessmentId: 'lehu382hdleh29',
389 | assessmentTitle: 'General Coding Assessment',
390 | assessmentStatus: 'active'
391 | }
392 | };Fired when an assessment is updated.
397 |{
399 | event: 'assessmentUpdated',
400 | triggeredOn: number,
401 | payload: {
402 | assessmentId: string,
403 | assessmentTitle: string,
404 | assessmentStatus: 'active' | 'archived' | 'deleted'
405 | }
406 | };{
409 | event: 'assessmentUpdated',
410 | triggeredOn: 1553720789347,
411 | payload: {
412 | assessmentId: 'lehu382hdleh29',
413 | assessmentTitle: 'General Coding Assessment',
414 | assessmentStatus: 'archived'
415 | }
416 | };Fired when a test session is created.
421 |{
423 | event: 'companyTestSessionCreated',
424 | triggeredOn: number,
425 | payload: {
426 | testSessionId: string,
427 | testId: string,
428 | testTitle: string,
429 | candidateEmail: string,
430 | candidateName: string
431 | }
432 | };{
435 | event: 'companyTestSessionCreated',
436 | triggeredOn: 1553720789347,
437 | payload: {
438 | testSessionId: 'lehu382hdleh29',
439 | testId: 'dhey29hcl28hl28',
440 | testTitle: 'Software Engineer intern',
441 | candidateEmail: 'jane.doe@gmail.com',
442 | candidateName: 'Jane Doe'
443 | }
444 | };
454 | Fired when a candidate declines a test session invitation.
458 |{
460 | event: 'preScreenCandidateDeclined',
461 | triggeredOn: number,
462 | payload: {
463 | testSessionId: string,
464 | testId: string,
465 | testTitle: string,
466 | candidateEmail: string,
467 | candidateName: string,
468 | externalId?: string
469 | }
470 | };{
473 | event: 'preScreenCandidateDeclined',
474 | triggeredOn: 1553720789347,
475 | payload: {
476 | testSessionId: 'lehu382hdleh29',
477 | testId: 'dhey29hcl28hl28',
478 | testTitle: 'Software Engineer intern',
479 | candidateEmail: 'jane.doe@gmail.com',
480 | candidateName: 'Jane Doe'
481 | }
482 | };487 | Fired when a candidate shares their existing result with a test session invitation. 488 |
489 |{
491 | event: 'preScreenResultShared',
492 | triggeredOn: number,
493 | payload: {
494 | testSessionId: string,
495 | testId: string,
496 | testTitle: string,
497 | candidateEmail: string,
498 | candidateName: string,
499 | duration: number,
500 | score: number,
501 | maxScore: number | null | undefined,
502 | plagiarismLevel: number, // deprecated
503 | plagiarismLabel: 'none' | 'low' | 'medium' | 'high' | '-', // deprecated
504 | url: string,
505 | codingScore?: number | null, // deprecated; use versionedCodingScore instead
506 | versionedCodingScore?: {
507 | version: 'original' | 'codingScore2023',
508 | value: number,
509 | },
510 | externalId?: string
511 | }
512 | };{
515 | event: 'preScreenResultShared',
516 | triggeredOn: 1553720789347,
517 | payload: {
518 | testSessionId: 'lehu382hdleh29',
519 | testId: 'dhey29hcl28hl28',
520 | testTitle: 'Software Engineer intern',
521 | candidateEmail: 'jane.doe@gmail.com',
522 | candidateName: 'Jane Doe',
523 | duration: 3480000, // 58 minutes
524 | score: 900,
525 | maxScore: 1000,
526 | codingScore: 820,
527 | versionedCodingScore: {
528 | version: 'codingScore2023',
529 | value: 575
530 | },
531 | plagiarismLevel: 0,
532 | plagiarismLabel: '-',
533 | url: https://app.codesignal.com/test-result/oH3qeBC38oFsf7qB4?accessToken=A7HnBpab4aD7xm7Kp-iPhk2se5Wnxeg7x9GruANLzn
534 | }
535 | };540 | Fired when a test session invitation cannot be fulfilled within the expiration 541 | window. The expiredReason field indicates whether the expiration is 542 | due to the test not being taken at all, or whether the test could not be certified 543 | by CodeSignal due to possibility/suspicion of cheating. If the latter, a 544 | rejectedReasons field will also be provided. 545 |
546 |{
548 | event: 'preScreenExpired',
549 | triggeredOn: number,
550 | payload: {
551 | testSessionId: string,
552 | testId: string,
553 | testTitle: string,
554 | candidateEmail: string,
555 | candidateName: string,
556 | externalId?: string,
557 | expiredReason: 'testNotTaken' | 'notCertified',
558 | rejectedReasons?: Array<string>,
559 | }
560 | };{
563 | event: 'preScreenExpired',
564 | triggeredOn: 1553720789347,
565 | payload: {
566 | testSessionId: 'lehu382hdleh29',
567 | testId: 'dhey29hcl28hl28',
568 | testTitle: 'Software Engineer intern',
569 | candidateEmail: 'jane.doe@gmail.com',
570 | candidateName: 'Jane Doe',
571 | expiredReason: 'notCertified',
572 | rejectedReasons: ['Unauthorized resource', 'Presence of others'],
573 | }
574 | };Fired when a candidate starts a test session.
579 |{
581 | event: 'companyTestSessionStarted',
582 | triggeredOn: number,
583 | payload: {
584 | testSessionId: string,
585 | testId: string,
586 | testTitle: string,
587 | candidateEmail: string,
588 | candidateName: string
589 | }
590 | };{
593 | event: 'companyTestSessionStarted',
594 | triggeredOn: 1553720789347,
595 | payload: {
596 | testSessionId: 'lehu382hdleh29',
597 | testId: 'dhey29hcl28hl28',
598 | testTitle: 'Software Engineer intern',
599 | candidateEmail: 'jane.doe@gmail.com',
600 | candidateName: 'Jane Doe'
601 | }
602 | };Fired when a candidate finishes a proctored test session.
607 |{
609 | event: 'preScreenResultVerificationPending',
610 | triggeredOn: number,
611 | payload: {
612 | testSessionId: string,
613 | testId: string,
614 | testTitle: string,
615 | candidateEmail: string,
616 | candidateName: string,
617 | duration: number,
618 | score: number,
619 | maxScore: number | null | undefined,
620 | codingScore?: number | null, // deprecated; use versionedCodingScore instead
621 | versionedCodingScore?: {
622 | version: 'original' | 'codingScore2023',
623 | value: number,
624 | },
625 | externalId?: string
626 | }
627 | };{
630 | event: 'preScreenResultVerificationPending',
631 | triggeredOn: 1553720789347,
632 | payload: {
633 | testSessionId: 'lehu382hdleh29',
634 | testId: 'dhey29hcl28hl28',
635 | testTitle: 'Software Engineer intern',
636 | candidateEmail: 'jane.doe@gmail.com',
637 | candidateName: 'Jane Doe',
638 | duration: 3480000, // 58 minutes
639 | score: 900,
640 | maxScore: 1000,
641 | codingScore: 820,
642 | versionedCodingScore: {
643 | version: 'codingScore2023',
644 | value: 575
645 | },
646 | }
647 | };Fired when a non-proctored test session is finished.
652 |{
654 | event: 'companyTestSessionFinished',
655 | triggeredOn: number,
656 | payload: {
657 | testSessionId: string,
658 | testId: string,
659 | testTitle: string,
660 | candidateEmail: string,
661 | candidateName: string,
662 | duration: number, // milliseconds
663 | score: number,
664 | maxScore: number,
665 | codingScore?: number | null, // deprecated; use versionedCodingScore instead
666 | versionedCodingScore?: {
667 | version: 'original' | 'codingScore2023',
668 | value: number,
669 | },
670 | plagiarismLevel: number, // deprecated
671 | plagiarismLabel: 'none' | 'low' | 'medium' | 'high' | '-', // deprecated
672 | url: string,
673 | }
674 | };{
677 | event: 'companyTestSessionFinished',
678 | triggeredOn: 1553720789347,
679 | payload: {
680 | testSessionId: 'lehu382hdleh29',
681 | testId: 'dhey29hcl28hl28',
682 | testTitle: 'Software Engineer intern',
683 | candidateEmail: 'jane.doe@gmail.com',
684 | candidateName: 'Jane Doe',
685 | duration: 3480000, // 58 minutes
686 | score: 900,
687 | maxScore: 1000,
688 | codingScore: 820,
689 | versionedCodingScore: {
690 | version: 'codingScore2023',
691 | value: 575
692 | },
693 | plagiarismLevel: 0,
694 | plagiarismLabel: '-',
695 | url: https://app.codesignal.com/test-result/oH3qeBC38oFsf7qB4?accessToken=A7HnBpab4aD7xm7Kp-iPhk2se5Wnxeg7x9GruANLzn
696 | }
697 | };Fired when a non-proctored test session's integrity review status is updated.
702 |{
704 | event: 'preScreenIntegrityReviewUpdated',
705 | triggeredOn: number,
706 | payload: {
707 | testSessionId: string,
708 | testId: string,
709 | testTitle: string,
710 | candidateEmail: string,
711 | candidateName: string,
712 | integrityReviewSuggested: boolean,
713 | }
714 | };{
717 | event: 'preScreenIntegrityReviewUpdated',
718 | triggeredOn: 1553720789347,
719 | payload: {
720 | testSessionId: 'lehu382hdleh29',
721 | testId: 'dhey29hcl28hl28',
722 | testTitle: 'Software Engineer intern',
723 | candidateEmail: 'jane.doe@gmail.com',
724 | candidateName: 'Jane Doe',
725 | integrityReviewSuggested: true
726 | }
727 | };
737 | 742 | Fired when a test session is marked as not verified by CodeSignal. This means that 743 | either the session has been flagged for suspicious behavior, or a technical issue 744 | has been identified during the session (in which case the candidate will be 745 | automatically granted a retake). 746 |
747 |{
749 | event: 'preScreenResultNotVerified',
750 | triggeredOn: number,
751 | payload: {
752 | testSessionId: string,
753 | testId: string,
754 | testTitle: string,
755 | candidateEmail: string,
756 | candidateName: string,
757 | rejectedReasons?: Array<string>,
758 | }
759 | };{
762 | event: 'preScreenResultNotVerified',
763 | triggeredOn: 1553720789347,
764 | payload: {
765 | testSessionId: 'lehu382hdleh29',
766 | testId: 'dhey29hcl28hl28',
767 | testTitle: 'Software Engineer intern',
768 | candidateEmail: 'jane.doe@gmail.com',
769 | candidateName: 'Jane Doe',
770 | rejectedReasons: ['Incomplete recording', 'Screen not visible],
771 | }
772 | };Fired when a proctored test session is verified by CodeSignal.
778 |{
780 | event: 'preScreenResultVerified',
781 | triggeredOn: number,
782 | payload: {
783 | testSessionId: string,
784 | testId: string,
785 | testTitle: string,
786 | candidateEmail: string,
787 | candidateName: string,
788 | duration: number, // milliseconds
789 | score: number,
790 | maxScore: number,
791 | codingScore?: number | null, // deprecated; use versionedCodingScore instead
792 | versionedCodingScore?: {
793 | version: 'original' | 'codingScore2023',
794 | value: number,
795 | },
796 | plagiarismLevel: number, // deprecated
797 | plagiarismLabel: 'none' | 'low' | 'medium' | 'high' | '-', // deprecated
798 | url: string,
799 | }
800 | };{
803 | event: 'preScreenResultVerified',
804 | triggeredOn: 1553720789347,
805 | payload: {
806 | testSessionId: 'lehu382hdleh29',
807 | testId: 'dhey29hcl28hl28',
808 | testTitle: 'Software Engineer intern',
809 | candidateEmail: 'jane.doe@gmail.com',
810 | candidateName: 'Jane Doe',
811 | duration: 3480000, // 58 minutes
812 | score: 900,
813 | maxScore: 1000,
814 | codingScore: 820,
815 | versionedCodingScore: {
816 | version: 'codingScore2023',
817 | value: 575
818 | },
819 | plagiarismLevel: 0,
820 | plagiarismLabel: '-',
821 | url: https://app.codesignal.com/test-result/oH3qeBC38oFsf7qB4?accessToken=A7HnBpab4aD7xm7Kp-iPhk2se5Wnxeg7x9GruANLzn
822 | }
823 | };
833 | 837 | Fired when an interviewer finishes a live interview or when a live interview times 838 | out. 839 |
840 |{
842 | event: 'liveInterviewFinished',
843 | triggeredOn: number,
844 | payload: {
845 | interviewId: string,
846 | candidateName: string,
847 | candidateEmail: string,
848 | startDate: number,
849 | endDate: number,
850 | questionsSolved: number,
851 | questionsAttempted: number,
852 | url: string,
853 | }
854 | };{
857 | event: 'liveInterviewFinished',
858 | triggeredOn: 1553720789347,
859 | payload: {
860 | interviewId: 'zWve8sgiLJit6isiM',
861 | candidateName: 'Jane Doe',
862 | candidateEmail: 'jane.doe@gmail.com',
863 | startDate: 1727896812565,
864 | endDate: 1727896849868,
865 | questionsSolved: 1,
866 | questionsAttempted: 2,
867 | url: https://app.codesignal.com/client-dashboard/interviews?status=over&liveInterviewId=zWve8sgiLJit6isiM
868 | }
869 | };Fired when an interviewer adds or updates interview feedback.
874 |{
876 | event: 'liveInterviewFeedbackUpdated',
877 | triggeredOn: number,
878 | payload: {
879 | interviewId: string,
880 | interviewerId: string,
881 | feedback: {
882 | generalNotes: string,
883 | categories?: Array<{
884 | name: string,
885 | attributes: Array<{
886 | name: string,
887 | score?: number,
888 | notes?: string,
889 | }>,
890 | }>,
891 | recommendedLevel?: string,
892 | overallEvaluation?: string,
893 | }
894 | }
895 | };{
898 | event: 'liveInterviewFeedbackUpdated',
899 | triggeredOn: 1553720789347,
900 | payload: {
901 | interviewId: 'zWve8sgiLJit6isiM',
902 | interviewerId: 'qcmbuCuxpHELGYEJw',
903 | feedback: {
904 | generalNotes: 'Great candidate, very knowledgeable',
905 | categories: [
906 | {
907 | name: 'Problem Solving',
908 | attributes: [
909 | {
910 | name: 'Problem Solving',
911 | score: 4,
912 | notes: 'Great problem solving skills',
913 | },
914 | {
915 | name: 'Code Quality',
916 | score: 3,
917 | },
918 | ],
919 | },
920 | {
921 | name: 'Communication',
922 | attributes: [
923 | {
924 | name: 'Communication',
925 | score: 5,
926 | notes: 'Excellent communication skills',
927 | },
928 | ],
929 | },
930 | ],
931 | recommendedLevel: 'Senior',
932 | overallEvaluation: 'Strong Yes',
933 | }
934 | }
935 | };