Skip to content

Commit

Permalink
Site updated to 05038cb
Browse files Browse the repository at this point in the history
  • Loading branch information
jlou-gh committed Aug 23, 2023
1 parent 1494089 commit acd6016
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
4 changes: 3 additions & 1 deletion assessment.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ <h2 id="assessment-api-change-log">Assessment API Change Log</h2>
<td>Date</td><td>Description</td></tr>
</thead><tbody>
<tr>
<td>Aug 22, 2023 3:00:00PM</td><td>Fixed URL expiry timing in <a href="#send-test">Send Test</a></td></tr>
<tr>
<td>Aug 21, 2019 2:00:00PM</td><td>Added Change Log and General Consideration sections to the Assessment API documentation</td></tr>
<tr>
<td>Aug 21, 2019 2:00:00PM</td><td>Added <a href="#patch-mark-test-as-completed">PATCH - Mark Test as Completed</a> endpoint</td></tr>
Expand Down Expand Up @@ -242,7 +244,7 @@ <h3 id="request">Request</h3>
<tr>
<td>last_name</td><td>String</td><td>Yes</td><td>The last name of the candidate.</td></tr>
<tr>
<td>resume_url</td><td>String</td><td>No</td><td>A URL to the candidate’s resume. This URL will expire 30 days after the request.</td></tr>
<td>resume_url</td><td>String</td><td>No</td><td>A URL to the candidate’s resume. This URL will expire 7 days after the request.</td></tr>
<tr>
<td>phone_number</td><td>String</td><td>No</td><td>The candidate’s phone number.</td></tr>
<tr>
Expand Down
11 changes: 9 additions & 2 deletions harvest.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ <h2 id="general-considerations">General considerations</h2>
<li>Properties without a value will use <code class="prettyprint">null</code> instead of being undefined</li>
<li>&ldquo;Snake Case&rdquo; is used for attribute names (e.g. <code class="prettyprint">first_name</code>)</li>
<li>Timestamps are rendered in ISO-8601 format (e.g. `2016-02-03T16:38:46.985Z)</li>
<li>URLs to external resources are valid for 30 days</li>
<li>URLs to external resources are valid for 7 days</li>
<li>We reserve the right to add more properties to objects, but will never change or remove them</li>
<li>Custom Fields on the <a href="#applications">application object</a> are only available to customers with Enterprise-level accounts</li>
<li>Resumes, cover letters, and other document attachments in Greenhouse are hosted on Amazon Web Services and are provided via signed, temporary URLs. Due to the ephemeral nature of these resource links, users should download these documents immediately after the request is made and should not rely on these URLs to be available for future requests. In the event AWS S3 is experiencing issues, document attachments will not be available in Harvest.</li>
Expand Down Expand Up @@ -263,6 +263,10 @@ <h2 id="harvest-change-log">Harvest Change Log</h2>
<td>Date</td><td>Description</td></tr>
</thead><tbody>
<tr>
<td>Aug 22, 2023 3:00:00PM</td><td>Included <code class="prettyprint">active</code> attribute in the <a href="#the-job-stage-object">Job Stage Object</a></td></tr>
<tr>
<td>Aug 22, 2023 3:00:00PM</td><td>Fixed URL expiry timing in <a href="#general-considerations">General Considerations</a> and the <a href="#the-candidate-object">Candidate Object</a></td></tr>
<tr>
<td>May 15, 2023 12:00:00PM</td><td>Added ability to update closed openings in the <a href="#patch-edit-openings">Edit Openings Endpoint</a></td></tr>
<tr>
<td>April 12, 2023 3:00:00PM</td><td>Modified format of request links for <a href="#post-scheduled-interviews">POST: Scheduled Interviews</a> and <a href="#patch-scheduled-interviews">PATCH: Scheduled Interviews</a>.</td></tr>
Expand Down Expand Up @@ -3113,7 +3117,7 @@ <h3 id="noteworthy-attributes">Noteworthy attributes</h3>
<tr>
<td>attachments[].type</td><td>One of: [&ldquo;resume&rdquo;, &ldquo;cover_letter&rdquo;, &ldquo;offer_packet&rdquo;, &ldquo;offer_letter&rdquo;, &ldquo;take_home_test&rdquo;, &ldquo;other&rdquo;]</td></tr>
<tr>
<td>attachments[].url</td><td>URLs expire in 30 days.</td></tr>
<td>attachments[].url</td><td>URLs expire in 7 days.</td></tr>
<tr>
<td>custom_fields</td><td>Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.</td></tr>
<tr>
Expand Down Expand Up @@ -9467,6 +9471,7 @@ <h2 id="the-job-stage-object">The job stage object</h2>
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Face to Face"</span><span class="p">,</span><span class="w">
</span><span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-22T05:31:37.263Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-22T05:31:37.263Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nt">"job_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">98765</span><span class="p">,</span><span class="w">
</span><span class="nt">"priority"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nt">"interviews"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
Expand Down Expand Up @@ -9539,6 +9544,8 @@ <h3 id="noteworthy-attributes">Noteworthy attributes</h3>
<tr>
<td>name</td><td>The name for this job stage</td></tr>
<tr>
<td>active</td><td>One of <code class="prettyprint">true</code> or <code class="prettyprint">false</code>:<br><code class="prettyprint">true</code> - The job stage is active<br><code class="prettyprint">false</code> - The job stage was deleted</td></tr>
<tr>
<td>job_id</td><td>The job that this stage belongs to</td></tr>
<tr>
<td>priority</td><td>Numeric field used for ordering, with the lowest values ordered first. For example, priority 0 indicates the first stage on a job</td></tr>
Expand Down
24 changes: 13 additions & 11 deletions webhooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -290,19 +290,19 @@ <h2 id="disabled-web-hooks">Disabled web hooks</h2>

<h2 id="retry-policy">Retry policy</h2>

<p>In the event of a failed webhook request (due to timeout, a non HTTP 200 response, or network issues), Greenhouse will attempt a maximum of 5 retries according to the formula on the right:</p>
<p>In the event of a failed webhook request (due to timeout, a non HTTP 200 response, or network issues), Greenhouse will attempt a maximum of 6 retries according to the formula on the right:</p>

<p>This formula increases the amount of time between each retry, while assigning a random number of seconds to avoid consistent failures from overload or contention.</p>

<p>Greenhouse will attempt 5 retries over the course of 7 hours.</p>
<pre class="highlight plaintext"><code>RETRY_DELAY_MINUTES = [1, 15, 60, 120, 240]
<p>Greenhouse will attempt 6 retries over the course of 15 hours.</p>
<pre class="highlight ruby"><code><span class="no">RETRY_DELAY_MINUTES</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">60</span><span class="p">,</span> <span class="mi">120</span><span class="p">,</span> <span class="mi">240</span><span class="p">,</span> <span class="mi">480</span><span class="p">]</span>

sidekiq_retry_in do |index, _exception|
seconds_delay = (RETRY_DELAY_MINUTES[index] || RETRY_DELAY_MINUTES.last) * 60
offset = rand(30) * (index + 1)
<span class="n">sidekiq_retry_in</span> <span class="k">do</span> <span class="o">|</span><span class="n">index</span><span class="p">,</span> <span class="n">_exception</span><span class="o">|</span>
<span class="n">seconds_delay</span> <span class="o">=</span> <span class="p">(</span><span class="no">RETRY_DELAY_MINUTES</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">||</span> <span class="no">RETRY_DELAY_MINUTES</span><span class="p">.</span><span class="nf">last</span><span class="p">)</span> <span class="o">*</span> <span class="mi">60</span>
<span class="n">offset</span> <span class="o">=</span> <span class="nb">rand</span><span class="p">(</span><span class="mi">30</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="n">index</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>

seconds_delay + offset
end
<span class="n">seconds_delay</span> <span class="o">+</span> <span class="n">offset</span>
<span class="k">end</span>
</code></pre>

<p>The table below outlines the estimated wait time for each retry request, assuming that rand(30) always returns 0.</p>
Expand All @@ -321,6 +321,8 @@ <h2 id="retry-policy">Retry policy</h2>
<td>4</td><td>120m</td><td>3h 16m</td></tr>
<tr>
<td>5</td><td>240m</td><td>7h 16m</td></tr>
<tr>
<td>6</td><td>480m</td><td>15h 16m</td></tr>
</tbody></table>

<h1 id="application-events">Application Events</h1>
Expand Down Expand Up @@ -1063,6 +1065,8 @@ <h3 id="noteworthy-response-attributes">Noteworthy response attributes</h3>
<td><code class="prettyprint">can_email</code></td><td>True or false; if this candidate can be e-mailed.</td></tr>
<tr>
<td><code class="prettyprint">application_ids</code></td><td>This is an array containing the Greenhouse application IDs that will be deleted as a consequence of this candidate being deleted</td></tr>
<tr>
<td><code class="prettyprint">deleted_application_ids</code></td><td>In many merge cases, this section will be blank, as applications will have been merged into the new candidate.</td></tr>
</tbody></table>

<h2 id="candidate-hired">Candidate hired</h2>
Expand Down Expand Up @@ -1370,8 +1374,6 @@ <h3 id="noteworthy-response-attributes">Noteworthy response attributes</h3>
<td>Attribute</td><td>Note</td></tr>
</thead><tbody>
<tr>
<td><code class="prettyprint">deleted_application_ids</code></td><td>In many merge cases, this section will be blank, as applications will have been merged into the new candidate.</td></tr>
<tr>
<td><code class="prettyprint">new_candidate_id</code></td><td>The ID of the candidate to whom this candidate has been merged</td></tr>
</tbody></table>

Expand Down Expand Up @@ -1884,7 +1886,7 @@ <h2 id="candidate-prospect-rejected">Candidate/Prospect rejected</h2>
</span><span class="p">}</span><span class="w">
</span></code></pre>

<p>The Reject Candidate event occurs when a prospect or candidate is rejected for a position.</p>
<p>The Reject Candidate event occurs when a prospect or candidate is rejected for a position. When candidates are rejected via a bulk action, a web hook will fire once for each candidate or prospect rejected.</p>

<p>See web hook <a href="#common-attributes">common attributes</a>.</p>

Expand Down

0 comments on commit acd6016

Please sign in to comment.