Assessment webhooks

.gitignore

@@ -3,3 +3,4 @@
 .idea/*
 node_modules/*
 __pycache__
+docs/diagrams/.*

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:

docs/webhooks/index.html

@@ -46,8 +46,10 @@ <h2>Table of Contents</h2>
                 <li>Events for CodeSignal Assessments</li>
                 <ul>
                   <li>
-                    <a href="#clientworkflow">Organization user workflow</a>
+                    <a href="#customerworkflow">Customer workflow</a>
                     <ul>
+                      <li><a href="#assessmentCreated">assessmentCreated</a></li>
+                      <li><a href="#assessmentUpdated">assessmentUpdated</a></li>
                       <li><a href="#companyTestSessionCreated">companyTestSessionCreated</a></li>
                     </ul>
                   </li>
@@ -79,7 +81,7 @@ <h2>Table of Contents</h2>
                     </ul>
                   </li>
                 </ul>
-                <li>Events for CodeSignal Live Interview</li>
+                <li>Events for CodeSignal Interviews</li>
                 <ul>
                   <li><a href="#liveinterviewworkflow">Live Interview webhooks process flow</a></li>
                   <li><a href="#liveInterviewFinished">liveInterviewFinished</a></li>
@@ -327,10 +329,10 @@ <h3 id="payloads">Webhook payloads</h3>
             </div>
           </div>
           <div class="section">
-            <h2>Events for CodeSignal Pre-Screen</h2>
+            <h2>Events for CodeSignal Assessments</h2>
             <div class="subsection">
               <p>
-                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.
               </p>
               <br />
               <img
@@ -340,14 +342,62 @@ <h2>Events for CodeSignal Pre-Screen</h2>
               />
             </div>
             <div class="subsection">
-              <h3 id="clientworkflow">Organization user workflow</h3>
+              <h3 id="customerworkflow">Customer workflow</h3>
               <br />
               <img
-                alt="Diagram of webhooks triggered on client flow"
+                alt="Diagram of webhooks triggered on customer flow"
                 width="80%"
                 src="../images/client-events.svg"
               />
             </div>
+            <div class="subsection">
+              <h3 id="assessmentCreated">assessmentCreated</h3>
+              <p>Fired when a new assessment is created.</p>
+              <div>Request format:</div>
+              <pre><code>{
+   event: 'assessmentCreated',
+   triggeredOn: number,
+   payload: {
+     assessmentId: string,
+     assessmentTitle: string,
+     assessmentStatus: 'active' | 'archived' | 'deleted'
+   }
+ };</code></pre>
+              <div>Sample request:</div>
+              <pre><code>{
+   event: 'assessmentCreated',
+   triggeredOn: 1553720789347,
+   payload: {
+     assessmentId: 'lehu382hdleh29',
+     assessmentTitle: 'General Coding Assessment',
+     assessmentStatus: 'active'
+   }
+ };</code></pre>
+            </div>
+            <div class="subsection">
+              <h3 id="assessmentUpdated">assessmentUpdated</h3>
+              <p>Fired when a new assessment is updated, including update events that do not end up changing anything on the assessment.</p>
+              <div>Request format:</div>
+              <pre><code>{
+   event: 'assessmentUpdated',
+   triggeredOn: number,
+   payload: {
+     assessmentId: string,
+     assessmentTitle: string,
+     assessmentStatus: 'active' | 'archived' | 'deleted'
+   }
+ };</code></pre>
+              <div>Sample request:</div>
+              <pre><code>{
+   event: 'assessmentUpdated',
+   triggeredOn: 1553720789347,
+   payload: {
+     assessmentId: 'lehu382hdleh29',
+     assessmentTitle: 'General Coding Assessment',
+     assessmentStatus: 'archived'
+   }
+ };</code></pre>
+            </div>
             <div class="subsection">
               <h3 id="companyTestSessionCreated">companyTestSessionCreated</h3>
               <p>Fired when a test session is created.</p>
@@ -380,7 +430,7 @@ <h3 id="companyTestSessionCreated">companyTestSessionCreated</h3>
               <h3 id="candidateworkflow">Candidate workflow</h3>
               <br />
               <img
-                alt="Diagram of webhooks triggered by the CodeSignal Pre-Screen product"
+                alt="Diagram of webhooks triggered by the CodeSignal Assessments product"
                 width="100%"
                 src="../images/candidate-events.svg"
               />
@@ -755,7 +805,7 @@ <h4 id="preScreenResultVerified">preScreenResultVerified</h4>
   }
 };</code></pre>
             </div>
-            <h2>Events for CodeSignal Live Interview</h2>
+            <h2>Events for CodeSignal Live Interviews</h2>
             <div class="subsection">
               <h3 id="liveinterviewworkflow">Live Interview webhooks process flow</h3>
               <img