Skip to content

Commit baaeb2f

Browse files
authored
Document external ID for all webhook events related to test sessions (#64)
* Document external ID for companyTestSessionFinished and preScreenResultVerified * Add externalId to payload docs for companyTestSessionCreated, companyTestSessionStarted, preScreenIntegrityReviewUpdated, preScreenResultNotVerified
1 parent 4c492be commit baaeb2f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/webhooks/index.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,8 @@ <h3 id="companyTestSessionCreated">companyTestSessionCreated</h3>
427427
testId: string,
428428
testTitle: string,
429429
candidateEmail: string,
430-
candidateName: string
430+
candidateName: string,
431+
externalId?: string,
431432
}
432433
};</code></pre>
433434
<div>Sample request:</div>
@@ -585,7 +586,8 @@ <h4 id="companyTestSessionStarted">companyTestSessionStarted</h4>
585586
testId: string,
586587
testTitle: string,
587588
candidateEmail: string,
588-
candidateName: string
589+
candidateName: string,
590+
externalId?: string,
589591
}
590592
};</code></pre>
591593
<div>Sample request:</div>
@@ -670,6 +672,7 @@ <h4 id="companyTestSessionFinished">companyTestSessionFinished</h4>
670672
plagiarismLevel: number, // deprecated
671673
plagiarismLabel: 'none' | 'low' | 'medium' | 'high' | '-', // deprecated
672674
url: string,
675+
externalId?: string,
673676
}
674677
};</code></pre>
675678
<div>Sample request:</div>
@@ -710,6 +713,7 @@ <h4 id="preScreenIntegrityReviewUpdated">preScreenIntegrityReviewUpdated</h4>
710713
candidateEmail: string,
711714
candidateName: string,
712715
integrityReviewSuggested: boolean,
716+
externalId?: string,
713717
}
714718
};</code></pre>
715719
<div>Sample request:</div>
@@ -755,6 +759,7 @@ <h4 id="preScreenResultNotVerified">preScreenResultNotVerified</h4>
755759
candidateEmail: string,
756760
candidateName: string,
757761
rejectedReasons?: Array&lt;string&gt;,
762+
externalId?: string,
758763
}
759764
};</code></pre>
760765
<div>Sample request:</div>
@@ -796,6 +801,7 @@ <h4 id="preScreenResultVerified">preScreenResultVerified</h4>
796801
plagiarismLevel: number, // deprecated
797802
plagiarismLabel: 'none' | 'low' | 'medium' | 'high' | '-', // deprecated
798803
url: string,
804+
externalId?: string,
799805
}
800806
};</code></pre>
801807
<div>Sample request:</div>

0 commit comments

Comments
 (0)