diff --git a/.gitignore b/.gitignore index 47b4c22..54c94a1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .idea/* node_modules/* __pycache__ +docs/diagrams/.* diff --git a/README.md b/README.md index f080ae9..e2e2691 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,10 @@ Since it's a static site, you can also just open `/docs/index.html` directly in The diagrams are generated using the following tool [diagrams](https://app.diagrams.net). 1. Go to that specific URL. -2. Select open existing diagram. +2. Open existing diagram. 3. Open `docs/diagrams/webhooks-flow.drawio` file. 4. Make all the needed changes. + - Note that the document has 2 pages -- one with the entire flow and one with individual sections. 5. Save the changes and put the resulting file on the repository to overwrite `docs/diagrams/webhooks-flow.drawio` file. To update each image: diff --git a/docs/diagrams/full-e2e-webhooks-flow.drawio b/docs/diagrams/full-e2e-webhooks-flow.drawio deleted file mode 100644 index 840863e..0000000 --- a/docs/diagrams/full-e2e-webhooks-flow.drawio +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/diagrams/webhooks-flow.drawio b/docs/diagrams/webhooks-flow.drawio index 32f751e..527a9aa 100644 --- a/docs/diagrams/webhooks-flow.drawio +++ b/docs/diagrams/webhooks-flow.drawio @@ -1,226 +1,497 @@ - - - + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - - + + - + + + + + + + + + + + + + + + + - - + + + - - + + - - + + - - - + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -230,40 +501,40 @@ - + - + - + - + - + - + - + - + - + - + diff --git a/docs/images/client-events.png b/docs/images/client-events.png deleted file mode 100644 index 1ee5ed5..0000000 Binary files a/docs/images/client-events.png and /dev/null differ diff --git a/docs/images/client-events.svg b/docs/images/client-events.svg index 4ded22d..208137e 100644 --- a/docs/images/client-events.svg +++ b/docs/images/client-events.svg @@ -1,3 +1,3 @@ -
Company Flow
Company Flow
A test session is created
A test session is c...
companyTestSessionCreated
companyTestSessionCreatedText is not SVG - cannot display \ No newline at end of file +
Customer Flow
Customer Flow
A test session is created
A test session...
companyTestSessionCreated
companyTestSessionCreated
assessmentCreated
assessmentCreated
Assessment updated
Assessment upda...
assessmentUpdated
assessmentUpdated
An assessment  is created
An assessment... \ No newline at end of file diff --git a/docs/images/full-e2e-prescreen-flow.png b/docs/images/full-e2e-prescreen-flow.png deleted file mode 100644 index 5aa1f81..0000000 Binary files a/docs/images/full-e2e-prescreen-flow.png and /dev/null differ diff --git a/docs/images/full-e2e-prescreen-flow.svg b/docs/images/full-e2e-prescreen-flow.svg index c9eeb55..48f45c4 100644 --- a/docs/images/full-e2e-prescreen-flow.svg +++ b/docs/images/full-e2e-prescreen-flow.svg @@ -1,4 +1,3 @@ - -
CodeSignal Verification Flow
CodeSignal Verification Flow
preScreenResultVerified
preScreenResultVerified
Codesignal Auditor
Codes...
Proctoring verification?
Proctoring verif...
Verified
Verified
preScreenResultNotVerfiied
preScreenResultNotVerfiied
Not verified
Not verified
* available only for proctored Pre-Screens
* available only for proctored Pre-Screens
Company Flow
Company Flow
A test session is created
A test session...
companyTestSessionCreated
companyTestSessionCreated
Candidate Flow
Candidate Flow
Candidate
Candi...
Starts Session?
Starts Session?
Receives an assessment request
Receives an assessment request
companyTestSessionStarted
companyTestSessionStarted
Yes
Yes
Proctored?
Proctored?
Session is finished
Session is finished
companyTestSessionFinished
companyTestSessionFinished
No
No
preScreenExpired
preScreenExpired
Yes
Yes
No
No
Expired?
Expired?
Yes
Yes
No
No
Declines the request?
Declines the req...
preScreenCandidateDeclined
preScreenCandidateDeclined
No
No
Share existing result?
Share existing r...
preScreenResultShared
preScreenResultShared
Yes
Yes
No
No
* available only for proctored Pre-Screens
* available only for proctored Pre-Screens
preScreenIntegrityReviewUpdated
preScreenIntegrityReviewUpdated
preScreenResultVerificationPending
preScreenResultVerificationPending
Yes
Yes \ No newline at end of file +
CodeSignal Verification Flow
CodeSignal Verification Flow
Customer Flow
Customer Flow
preScreenResultVerified
preScreenResultVerified
CodeSignal Auditor
CodeS...
Proctoring verification?
Proctoring verif...
Verified
Verified
preScreenResultNotVerfiied
preScreenResultNotVerfiied
Not verified
Not verified
* available only for proctored Assessments
* available only for proctored Assessments
A test session is created
A test session...
companyTestSessionCreated
companyTestSessionCreated
assessmentCreated
assessmentCreated
Assessment updated
Assessment upda...
assessmentUpdated
assessmentUpdated
Test-taker
Test-...
Starts Session?
Starts Session?
Receives an assessment request
Receives an assessment request
companyTestSessionStarted
companyTestSessionStarted
Yes
Yes
Proctored?
Proctored?
Session is finished
Session is finished
companyTestSessionFinished
companyTestSessionFinished
No
No
preScreenExpired
preScreenExpired
Yes
Yes
No
No
Expired?
Expired?
Yes
Yes
No
No
Declines the request?
Declines the req...
preScreenCandidateDeclined
preScreenCandidateDeclined
No
No
Share existing result?
Share existing r...
preScreenResultShared
preScreenResultShared
Yes
Yes
No
No
* available only for proctored Assessments
* available only for proctored Assessments
preScreenResultVerificationPending
preScreenResultVerificationPending
Yes
Yes
An assessment  is created
An assessment...
Test-taker Flow
Test-taker Flow
preScreenIntegrityReviewUpdated
preScreenIntegrityReviewUpdated \ No newline at end of file diff --git a/docs/webhooks/index.html b/docs/webhooks/index.html index 17283b6..9009ead 100644 --- a/docs/webhooks/index.html +++ b/docs/webhooks/index.html @@ -46,8 +46,10 @@

Table of Contents

  • Events for CodeSignal Assessments
    • -
  • Events for CodeSignal Live Interview
    • +
  • Events for CodeSignal Interviews
    • Live Interview webhooks process flow
    • liveInterviewFinished
      • @@ -327,10 +329,10 @@

      Webhook payloads

      -

      Events for CodeSignal Pre-Screen

      +

      Events for CodeSignal Assessments

      - Here is an overview of the end to end workflow of events for CodeSignal Pre-Screen. + Here is an overview of the end to end workflow of events for CodeSignal Assessments.


      Events for CodeSignal Pre-Screen />
      -

      Organization user workflow

      +

      Customer workflow


      Diagram of webhooks triggered on client flow
      +
      +

      assessmentCreated

      +

      Fired when a new assessment is created.

      +
      Request format:
      + 
      {
+   event: 'assessmentCreated',
+   triggeredOn: number,
+   payload: {
+     assessmentId: string,
+     assessmentTitle: string,
+     assessmentStatus: 'active' | 'archived' | 'deleted'
+   }
+ };
      +
      Sample request:
      + 
      {
+   event: 'assessmentCreated',
+   triggeredOn: 1553720789347,
+   payload: {
+     assessmentId: 'lehu382hdleh29',
+     assessmentTitle: 'General Coding Assessment',
+     assessmentStatus: 'active'
+   }
+ };
      +
      +
      +

      assessmentUpdated

      +

      Fired when an assessment is updated.

      +
      Request format:
      + 
      {
+   event: 'assessmentUpdated',
+   triggeredOn: number,
+   payload: {
+     assessmentId: string,
+     assessmentTitle: string,
+     assessmentStatus: 'active' | 'archived' | 'deleted'
+   }
+ };
      +
      Sample request:
      + 
      {
+   event: 'assessmentUpdated',
+   triggeredOn: 1553720789347,
+   payload: {
+     assessmentId: 'lehu382hdleh29',
+     assessmentTitle: 'General Coding Assessment',
+     assessmentStatus: 'archived'
+   }
+ };
      +

      companyTestSessionCreated

      Fired when a test session is created.

      @@ -380,7 +430,7 @@

      companyTestSessionCreated

      Candidate workflow


      Diagram of webhooks triggered by the CodeSignal Pre-Screen product @@ -755,7 +805,7 @@

      preScreenResultVerified

      } };
      -

      Events for CodeSignal Live Interview

      +

      Events for CodeSignal Live Interviews

      Live Interview webhooks process flow