Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ON-6740 resolve api documentation side menu visual bug #19

Open
wants to merge 1,596 commits into
base: dev
Choose a base branch
from
Open
Changes from 2 commits
Commits
Show all changes
1596 commits
Select commit Hold shift + click to select a range
9637db1
Adding change log
mmurph24 Sep 1, 2020
c8177ff
Merge pull request #386 from liamkillion/remove_can_email_from_patch_…
tdphillipsjr Sep 14, 2020
23a944f
Fix rejection reason docs.
tdphillipsjr Sep 14, 2020
2bbc932
fix json
tdphillipsjr Sep 14, 2020
cdb034b
Merge pull request #397 from grnhse/GREEN-24282_update_rejection_reasons
tdphillipsjr Sep 14, 2020
9065609
Merge pull request #396 from grnhse/GREEN-25127-standardized-descript…
capablemonkey Sep 16, 2020
3b4e54d
update the definition of 'public' on the jobs endpoint
tdphillipsjr Sep 18, 2020
2ed3468
Merge pull request #398 from grnhse/GREEN-25671_ingestion_api_docs
tdphillipsjr Sep 18, 2020
d6612e2
update to link custom application field section to custom field param…
liamkillion Sep 21, 2020
b61af47
Adds attachments to applications object.
tdphillipsjr Sep 23, 2020
58c9202
add quotes
tdphillipsjr Sep 23, 2020
f79cabf
Change log.
tdphillipsjr Sep 23, 2020
97db980
Merge pull request #400 from grnhse/GREEN-25732_attachment_docs
tdphillipsjr Sep 24, 2020
bce9923
Adds required to demographic questions.
tdphillipsjr Sep 25, 2020
7cc1a0d
Merge pull request #401 from grnhse/GREEN-25767_add_required_to_demog…
tdphillipsjr Sep 28, 2020
6c5f09c
Merge pull request #380 from et/patch-1
tdphillipsjr Sep 28, 2020
105e074
Merge pull request #399 from liamkillion/applications-patch
tdphillipsjr Sep 28, 2020
178ca2f
Updates GHO API for custom employment statuses
nycdavid May 28, 2020
648d3b4
Remove employment status enums from introduction
nycdavid Jun 11, 2020
2a9a427
Change order to be alphabetical
nycdavid Sep 30, 2020
09ea1d9
Merge pull request #382 from grnhse/ON-4251-emp-status-graphql
nycdavid Sep 30, 2020
4c7921c
POST: Add Candidate
hardyclervil Oct 2, 2020
56edfcb
Updated documentation to reflect new tiers
hardyclervil Oct 2, 2020
8406ae2
Ingestion API Permissions Doc Update
pkelliher Oct 4, 2020
a97f98a
Merge branch 'master' into update-customer-tiers
liamkillion Oct 5, 2020
3d5a66b
Merge pull request #404 from corvo792/update-customer-tiers
liamkillion Oct 5, 2020
4fa805a
Clarifying that existing integrations will still work even though pol…
javi-dominguez Oct 6, 2020
86f01c2
moving Add Application to Application Section
ryanartha Oct 7, 2020
d762cfe
Adding language for cloud-based URLS
ryanartha Oct 7, 2020
6759da9
Inserted JSON for Patcn Enable User and reranged the http endpoint fo…
pkelliher Oct 10, 2020
11c73d6
add docs
tdphillipsjr Oct 12, 2020
358ef43
template may be null.
tdphillipsjr Oct 12, 2020
6a9fa79
Merge pull request #410 from grnhse/GREEN-25968_is_template_to_docs
tdphillipsjr Oct 12, 2020
3588bb8
Merge pull request #408 from grnhse/assessment-clarify-existing-integ…
tdphillipsjr Oct 12, 2020
2a30c3a
Merge pull request #407 from grnhse/POST-Attachments-Language-Update
tdphillipsjr Oct 12, 2020
19a9739
Merge pull request #406 from grnhse/Add-Application-Link
tdphillipsjr Oct 12, 2020
7ee1886
Merge pull request #409 from grnhse/UpdatePatchEnableUserJSON
liamkillion Oct 13, 2020
3804f6d
Update _jobs.md
tehdiplomat Dec 4, 2020
58f7e21
Adds answer types to demographic questions
Dec 11, 2020
77065ba
Update _jobs.md
tehdiplomat Dec 15, 2020
a40752b
Update employmentStatuses endpoint to return a list of strings
skuo-gh Dec 17, 2020
6351b3d
Merge pull request #415 from grnhse/ON-4575
skuo-gh Dec 21, 2020
877baff
Merge pull request #414 from grnhse/GREEN-26810_demographic_questions…
glovguy Dec 21, 2020
ba9f418
list all possible statuses of Application
yoloVoe Jan 13, 2021
8c9f5c4
Fix typo in _applications.md
alan-fang Feb 4, 2021
b8a9a88
Add an example for terminating GHO employee
skuo-gh Feb 11, 2021
2017cbb
Merge pull request #423 from grnhse/gho-terminate-employee
skuo-gh Feb 11, 2021
719310a
Add PATCH user permission level docs
noralin Apr 9, 2021
3d6e8bc
Fix styling
noralin Apr 13, 2021
843433a
Merge pull request #426 from grnhse/GREEN-28494-add-user-permission-l…
noralin Apr 13, 2021
ddf7157
Update Ingestion API get current user docs
noralin Apr 14, 2021
664cdc1
Remove "Required" column for Response Parameters
noralin Apr 14, 2021
67b014f
Add release instructions to README
noralin Apr 14, 2021
4e324c7
Merge pull request #427 from grnhse/GREEN-28712-update-ingestion-api-…
noralin Apr 15, 2021
6a20692
Update changelogs
noralin Apr 16, 2021
febae92
Merge pull request #428 from grnhse/update-api-changelogs
noralin Apr 16, 2021
49beed2
Update EEOC copy
noralin Apr 19, 2021
b32fc7d
Add external_id examples to custom field options
noralin Apr 19, 2021
786090e
Merge pull request #429 from grnhse/GREEN-28739-update-docs
noralin Apr 21, 2021
effacdb
Merge pull request #430 from grnhse/GREEN-24412-update-eeoc-copy
noralin Apr 21, 2021
b3791e3
Add job_post_id to application response object
noralin Apr 28, 2021
945d79f
Add priority to Job Stages object
noralin May 3, 2021
be9e192
Merge pull request #431 from grnhse/GREEN-28903-add-job-post-id-to-apps
noralin May 3, 2021
1a017a6
Make it clear that email refers to work email
skuo-gh May 6, 2021
1fbef2d
Remove deprecated fields from Departments and Locations
skuo-gh May 6, 2021
d26db04
Add video_conferencing_url to Scheduled Interviews
noralin May 18, 2021
492c312
Merge pull request #432 from grnhse/ON-4130
skuo-gh May 18, 2021
d13696d
Merge pull request #433 from grnhse/GREEN-29176-addd-video-conferenci…
noralin May 18, 2021
9ccad25
Docs for Prospect Post Harvest API Updates
noralin May 19, 2021
a2313e7
Move "Prospect created" webhook from Candidate Events to Application …
noralin May 19, 2021
ea5b49a
Update PUT Replace Hiring Team instruction
noralin May 19, 2021
826d6da
Update rejection reason type description
noralin May 21, 2021
57a65f8
Merge pull request #435 from grnhse/update-docs
noralin May 21, 2021
fbd2e00
Fix websites property in docs
jessepinho Jun 21, 2021
2c18a71
Delete doc about libraries from job board api
noralin Jun 25, 2021
9441f9d
Delete docs about omniauth
noralin Jun 25, 2021
b89e13b
Merge pull request #437 from grnhse/GREEN-29583-delete-omniauth-docs
noralin Jun 28, 2021
1627a9d
Merge pull request #438 from grnhse/GREEN-29580-delete-libraries-from…
noralin Jun 28, 2021
09dec6b
Update webhook retry docs
noralin Aug 3, 2021
d5b395e
Merge pull request #439 from grnhse/GREEN-30118-update-webhook-retry-…
noralin Aug 9, 2021
57bb2d4
Fix typo
ewawrzas Oct 28, 2020
f08c079
Update docs to reflect support for non-deletable fields
ewawrzas Aug 25, 2021
5b83992
Merge pull request #441 from grnhse/ON-4917-non-deletable-field-type-…
ewawrzas Aug 25, 2021
9f1eea7
typo
jsan-repo Oct 21, 2021
cf4df6c
fixed typo for prospective_department and prospective_office having t…
kfuchs Nov 24, 2021
934a48e
Merge pull request #449 from grnhse/GREEN-30828-bug-fixed-typo-on-app…
kfuchs Nov 24, 2021
06c82c6
Merge pull request #411 from grnhse/single-select-demo-questions
jsurrett Jan 31, 2022
684738e
Merge pull request #421 from alan-fang/patch-1
jsurrett Feb 1, 2022
fdaa93b
Merge pull request #436 from jessepinho/patch-1
jsurrett Feb 1, 2022
52fd234
Merge pull request #446 from jsan-repo/patch-2
jsurrett Feb 1, 2022
9662731
Merge pull request #419 from yoloVoe/patch-1
jsurrett Feb 2, 2022
3fe86f7
Green-32355: Update gems
jsurrett Feb 2, 2022
6030526
mark email required in AddPendingHireInput
abbygh Feb 23, 2022
14ca8be
Merge pull request #457 from grnhse/ON-3781
abbygh Feb 23, 2022
2d6c1ed
Remove deprecated employees query arguments
hdensten Mar 16, 2022
4fbd7f8
Merge pull request #461 from grnhse/ON-5217-delete-deprecated-employe…
hdensten Mar 17, 2022
3007322
add examples to queries and mutations
abbygh Mar 31, 2022
1e765f5
Merge pull request #462 from grnhse/ON-5279
abbygh Apr 5, 2022
68a9070
Add documentation for external_id query param for list departments an…
noralin Jun 22, 2022
f7bf799
Merge pull request #465 from grnhse/GREEN-34790-fix-get-offices-dept-…
noralin Jun 24, 2022
4a68072
Remove the unnecessary therubyracer gem
noralin Jun 24, 2022
361d9f2
Merge pull request #466 from grnhse/remove-rubyracer-gem
noralin Jun 24, 2022
ad8f916
Content type is now required when adding attachments
noralin Jul 15, 2022
3d2c507
Fix post add user tier language
noralin Aug 3, 2022
1e07c59
Merge pull request #471 from grnhse/content-type-requiredness
noralin Aug 3, 2022
314f01f
Update reject application docs
noralin Aug 10, 2022
c717e7a
Merge pull request #474 from grnhse/update-reject-application-docs
noralin Aug 12, 2022
cb00902
Add endpoint
tdphillipsjr Sep 6, 2022
81315b2
Patch not post.
tdphillipsjr Sep 7, 2022
ff5f2cd
Merge pull request #477 from grnhse/GREEN-36227_add_convert_prospect
tdphillipsjr Sep 8, 2022
03f1aad
Update application attachment doc examples to include created_at
noralin Sep 9, 2022
b6b1da7
Merge pull request #478 from grnhse/GREEN-36306-update-application-at…
noralin Sep 12, 2022
771d226
Updated change log to reflect the create_at change for application's …
noralin Sep 12, 2022
df064de
Merge pull request #479 from grnhse/GREEN-36359-update-change-logs
noralin Sep 12, 2022
a8cd8e6
Add docs for new v2 endpoint
tdphillipsjr Sep 20, 2022
e1dfd96
Finish sentence.
tdphillipsjr Sep 20, 2022
c32b85e
Updates from tech writing.
tdphillipsjr Sep 20, 2022
374d3bd
Removes a second a
tdphillipsjr Sep 20, 2022
4b64286
Update webhooks retry policy documentation
noralin Sep 20, 2022
ee0cc4e
Merge pull request #483 from grnhse/GREEN-36491-update-webhook-retry-…
noralin Sep 21, 2022
d6ee5c0
Merge pull request #482 from grnhse/GREEN-36446_openings_v2_docs
tdphillipsjr Sep 23, 2022
36e0afd
Update _introduction.md
nkemnwan Oct 14, 2022
b2d9732
Merge pull request #486 from grnhse/add-attachment-note-expiration
nkemnwan Oct 17, 2022
a9e4083
Add user attribute fields to User endpoints
javi-dominguez Aug 3, 2022
f9b78b5
Add user attribute changes to enable and disable endpoints
javi-dominguez Aug 3, 2022
3390dd5
Add user attribute fields to PATCH/POST methods
javi-dominguez Aug 3, 2022
b6aeff3
Add user attributes to Custom Fields endpoint
javi-dominguez Aug 3, 2022
6ffde54
Update change log
javi-dominguez Aug 3, 2022
6673370
Added external_office_ids and external_department_ids, updated change…
javi-dominguez Aug 12, 2022
9f7732d
Merge pull request #473 from grnhse/GREEN-32758-2-update-harvest-docu…
pcrglennon Oct 18, 2022
acf5f77
Add pay transparency query param to jben job post request docs
JoshNassar94 Nov 2, 2022
fac99ca
Show 2 decimal places
JoshNassar94 Nov 3, 2022
295669c
Update api response
JoshNassar94 Nov 9, 2022
78893f6
Update description
JoshNassar94 Nov 9, 2022
ddd4589
Update full_content description
JoshNassar94 Nov 10, 2022
30e10fb
Merge pull request #488 from grnhse/green-37301-jben-api-docs
JoshNassar94 Nov 10, 2022
9672574
Update _jobs.md
cclark11 Nov 15, 2022
fc9b1be
Note that V1 has been removed.
tdphillipsjr Nov 22, 2022
2c1892a
Merge pull request #490 from grnhse/remove_delete_openings_v1
tdphillipsjr Nov 22, 2022
79b79a4
Merge pull request #489 from grnhse/cclark11-patch-1
tdphillipsjr Nov 22, 2022
cb3ad26
Changelog update to deprecate v2 of destroy openings.
tdphillipsjr Nov 23, 2022
6b62ac1
Merge pull request #491 from grnhse/changelog_update
tdphillipsjr Nov 23, 2022
a1a16af
Update webhook docs
noralin Nov 23, 2022
c94bbce
Merge pull request #492 from grnhse/GREEN-37432-update-webhook-docs
noralin Nov 23, 2022
6337cb4
GREEN-38181 Update api docs to reflect reality
noralin Dec 23, 2022
3b39a5c
Merge pull request #496 from grnhse/GREEN-38181-fix-api-docs
noralin Dec 23, 2022
956d664
Add char limit under field validations
dianajyoo Jan 11, 2023
b58f603
Remove outdated note, we now support creating of other custom field t…
noralin Jan 13, 2023
fb43847
Merge pull request #504 from grnhse/GREEN-38779-remove-outdated-note
noralin Jan 13, 2023
9fae1b2
Merge pull request #503 from grnhse/GREEN-38700-update-job-board-api-…
dianajyoo Jan 18, 2023
f3a0bd8
Add more detail to approval type
jlou-gh Feb 23, 2023
4c6905a
Fix whitespacing
jlou-gh Feb 23, 2023
91f9be5
Merge pull request #506 from grnhse/GREEN-39373-add-more-detail-to-ap…
jlou-gh Feb 24, 2023
40d23e0
Update docs to include param
JoshNassar94 Mar 2, 2023
595dd09
Update comment for false case
JoshNassar94 Mar 2, 2023
d140244
Merge pull request #508 from grnhse/green-39797
JoshNassar94 Mar 7, 2023
30c5ea5
Update change log
JoshNassar94 Mar 15, 2023
2273732
Add a PR template
JoshNassar94 Mar 15, 2023
3d13718
Specify harvest api
JoshNassar94 Mar 15, 2023
4c3e4bc
Update template
JoshNassar94 Mar 15, 2023
3d82844
Merge pull request #509 from grnhse/green-40223
JoshNassar94 Mar 15, 2023
1239f20
Update docs to include compensation fields
petefio Mar 16, 2023
b8d283f
Merge pull request #510 from grnhse/GREEN-38992-compensation-field-docs
tdphillipsjr Mar 20, 2023
41880eb
📝 Fix doc format for scheduled interviews
anirudhmungre Apr 12, 2023
c319010
📝 Update Changlog
anirudhmungre Apr 12, 2023
fdd0da6
Merge pull request #511 from grnhse/bug/GREEN-40251/Scheduled-intervi…
anirudhmungre Apr 14, 2023
8eebfd6
GREEN-41695 - Harvestt PATCH openings: update documentation
jc-greenhouse May 10, 2023
d179574
GREEN-41695 - Harvestt PATCH openings: update documentation
jc-greenhouse May 10, 2023
b413695
Merge branch 'master' into GREEN-41695
jc-greenhouse May 10, 2023
07fdb48
[GREEN-41695] Altered date of changelog release
jc-greenhouse May 15, 2023
3a65355
Merge pull request #512 from grnhse/GREEN-41695
jc-greenhouse May 15, 2023
c3f92cb
Add audit log api documentation
jlou-gh Jun 5, 2023
c293f22
Fix header and pagination
jlou-gh Jun 12, 2023
c9c4b4b
Change url for auditlog to us
jlou-gh Jun 12, 2023
2faa788
Add audit log tile
jlou-gh Jun 13, 2023
87a09ae
Add new logos
jlou-gh Jun 13, 2023
c2f6a01
Remove ruby tab for audit log
jlou-gh Jun 21, 2023
d7b1db5
✨ Add google analytics to developer resources page
anirudhmungre Jun 26, 2023
dbc371a
Merge pull request #513 from grnhse/GREEN-42469/Add-google-analytics
anirudhmungre Jun 27, 2023
46727ef
Fix timestamp in audit log
jlou-gh Jun 28, 2023
33b8340
Revert timestamp change
jlou-gh Jun 28, 2023
dcecd5b
Change uri for audit log docs
jlou-gh Jul 12, 2023
c236909
doc: reflect new decoupling of processing and retention consent
iannguyen Jul 12, 2023
7e6873b
doc: include original `gdpr_consent_given` value, mentioning that it …
iannguyen Jul 12, 2023
b2cc973
doc: update copy based on feedback
iannguyen Jul 19, 2023
011af17
Merge pull request #515 from grnhse/green-39061-2
iannguyen Jul 20, 2023
2f4cbc1
Documenting new parameters to audit log
jlou-gh Aug 20, 2023
0a3b0cf
Remove harvest doc inside of audit logs
jlou-gh Aug 20, 2023
4fc2678
Fix text for magic_time in audit log
jlou-gh Aug 20, 2023
a4a4ab2
Add changelog
jlou-gh Aug 20, 2023
6114a8d
🐛 GREEN-37557: Correct deleted_application_ids location
anirudhmungre Aug 22, 2023
f679fa6
🐛 GREEN-39712: Update retry policy to include additional retry
anirudhmungre Aug 22, 2023
088d501
🐛 GREEN-41753: Fix URL expiry 30d -> 7d
anirudhmungre Aug 22, 2023
50d27c9
✨ GREEN-43098: Include bulk action info for rejected candidate webhook
anirudhmungre Aug 22, 2023
af57471
✨ GREEN-43310: Include `active` attribute in job stage object
anirudhmungre Aug 22, 2023
f37dd22
🔊 Update change logs for harvest and assessment apis
anirudhmungre Aug 22, 2023
05038cb
Merge pull request #517 from grnhse/bugs/GREEN-43914/Bulk-fix-docs
anirudhmungre Aug 23, 2023
7c28ccb
✨ GREEN-44504/GREEN-44506: modify copy and add link to mail for audit…
anirudhmungre Sep 26, 2023
63d8d24
Merge pull request #519 from grnhse/feature/GREEN-44504/GREEN-44506/A…
anirudhmungre Oct 1, 2023
4fcea69
GREEN-44497 Update Throttling to Rate Limiting in Harvest API documen…
OmodaraAdonai Oct 12, 2023
767641d
GREEN-44497 Update Harvest Change Log to add Throttling changes
OmodaraAdonai Oct 12, 2023
cd6929b
Add response_error URL to list of requirements
bradleyknutson Oct 13, 2023
f5a2aaa
Add response_error to change log
bradleyknutson Oct 13, 2023
4310b57
Merge pull request #521 from grnhse/bk/green-44903/assessment-api-req…
bradleyknutson Oct 16, 2023
fa8c4b7
Merge pull request #520 from grnhse/GREEN-44497-update-harvest-thrott…
OmodaraAdonai Oct 17, 2023
4e85740
GREEN-45026 Update assessment API docs for active, unhired candidates
onebree Oct 19, 2023
eb6566f
Merge pull request #522 from grnhse/hs/GREEN-45026
onebree Oct 19, 2023
ef191bc
GREEN-43519 Update Audit log pagination documentation
OmodaraAdonai Oct 26, 2023
78e2e73
GREEN-44151 Remove Harvest API documentation that put-anonymize-candi…
OmodaraAdonai Oct 30, 2023
77431fa
GREEN-43530-update-audit-log-rate-limiting-api-documentation
OmodaraAdonai Nov 6, 2023
4f95b84
GREEN-43530 Update Rate Limiting section of Audit Log documentation
OmodaraAdonai Nov 6, 2023
0130f6a
GREEN-44302 Remove On-Behalf-Of Header from events object sample payl…
OmodaraAdonai Nov 7, 2023
3f4ba99
Update error message
jlou-gh Nov 13, 2023
8a5686a
Merge pull request #529 from grnhse/GREEN-44498
jlou-gh Nov 13, 2023
a65a3ef
Fix link for error status code
jlou-gh Nov 14, 2023
157d494
GREEN-44007 Updated Job Post response objects to include job_post_cus…
OmodaraAdonai Nov 15, 2023
d29e87b
GREEN-44007 Updated remaining Job Post response objects to include jo…
OmodaraAdonai Nov 15, 2023
7e5a7e8
GREEN-44007 Fix indentation in the job post object
OmodaraAdonai Nov 17, 2023
f83b8e7
include max number of records in pagination copy
malikflx Dec 6, 2023
ad2eca9
Merge pull request #532 from grnhse/ON-6545-include-max-number-of-rec…
malikflx Dec 7, 2023
8e6f5fd
🐛 GREEN-46089: Add missing events endpoint to left nav menu
anirudhmungre Dec 12, 2023
44bb6f4
GREEN-45139 Add a Note to PATCH Update Current Offer documentation
OmodaraAdonai Dec 11, 2023
c38cc2f
Add assignedTaskName field to Document
ewawrzas Dec 14, 2023
74c8c26
Merge pull request #535 from grnhse/ON-6567-add-assignedTaskName-to-D…
ewawrzas Dec 14, 2023
c6a756e
GREEN-44733 Update Developer Resources main page
OmodaraAdonai Feb 22, 2024
db5d08c
GREEN-46094 Update description of the application parameter in POST: …
OmodaraAdonai Feb 23, 2024
dee8bc8
Add formFields type and description https://github.com/grnhse/onboard…
ewawrzas Mar 14, 2024
a6af8c8
Add JSON scalar https://github.com/rmosolgo/graphql-ruby/blob/4315fb1…
ewawrzas Mar 14, 2024
137a70b
Add signatureRequest formField to example
ewawrzas Mar 14, 2024
b24a0e5
Merge pull request #541 from grnhse/ON-6637-add-signature-request-for…
ewawrzas Mar 14, 2024
4eff976
Fix link and brackets
ewawrzas Mar 14, 2024
38ac75b
Merge pull request #542 from grnhse/Onboarding-fix-json-scalar
ewawrzas Mar 14, 2024
7c136f4
Add an example of requesting e-signatures with formFields
hugomarcotte Mar 15, 2024
4a5b3a2
GREEN-48423 Update Rate-limiting documentation
OmodaraAdonai Mar 21, 2024
8732cf3
GREEN-48148 Update Harvest API GET:List Candidates documentation
OmodaraAdonai Mar 21, 2024
7fbc6e1
GREEN-46436 Update List and Retrieve Offices documentation
OmodaraAdonai Apr 12, 2024
da5e3a0
Improve examples
jaydeesimon Apr 25, 2024
ce119e3
Merge pull request #546 from grnhse/GREEN-49304-scrub-content-pass-1
jaydeesimon Apr 25, 2024
fa9c92f
📝 GREEN-50097: Include skip_count param in list endpoint docs
anirudhmungre Jun 13, 2024
513f522
GREEN-50428: Update Post: Reject Application parameter description
OmodaraAdonai Jul 9, 2024
519675b
GREEN-43519: Update job opening opened_at parameter description
OmodaraAdonai Jul 10, 2024
c2262a4
accept rejection_details through PATCH application
julienguyenn Jul 8, 2024
65ea436
update changelog
julienguyenn Jul 8, 2024
cbcda67
Merge pull request #550 from grnhse/GREEN-51034
julienguyenn Jul 11, 2024
ba0a761
GREEN-49207: Update slate
jsurrett Jul 25, 2024
f4d99a2
Merge pull request #553 from grnhse/GREEN-49207-update-slate
jsurrett Jul 29, 2024
8e920c3
GREEN-51797: Developer resources - replace 'web hook' with webhook
OmodaraAdonai Aug 7, 2024
eb73ea3
GREEN-51905: Add created_by_id to sample webhook payloads
OmodaraAdonai Aug 16, 2024
ae7c61d
update page-specific variable names to match recent slate updates
malikflx Aug 22, 2024
a71f638
Remove types links from the queries and mutations navigation
malikflx Aug 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions source/includes/webhooks/_introduction.md
Original file line number Diff line number Diff line change
@@ -167,24 +167,32 @@ Currently, Web Hooks for all event types include these common attributes:
}
```

Custom fields may be attached to several objects within the Greenhouse Recruiting system. These fields may appear on candidates, applications, offers, and other objects in the system. These fields share several properties and are always indicated in web hooks by the "custom_fields" element. However, the "value" attribute of custom fields are different depending on the "type" attribute, so you must check the "type" attribute in order to predict what will be included in the value "attribute". As described in the previous section, the type attribute will be one of short_text, long_text, boolean, single_select, multi_select, currency, currency_range, number, number_range, date, url, or user. An example of each of these fields' expected value format are provided.
Custom fields may be attached to several objects within the Greenhouse Recruiting system. These fields may appear on candidates, applications, offers, and other objects in the system. These fields share several properties and are always indicated in web hooks by the "custom_fields" element. However, the "value" attribute of custom fields are different depending on the "type" attribute, so you must check the "type" attribute in order to predict what will be included in the value "attribute". As described in the previous section, the type attribute will be one of short_text, long_text, boolean, single_select, multi_select, currency, currency_range, number, number_range, date, url, or user. An example of each of these fields' expected value format are provided.

## Disabled web hooks

If a web hook is disabled, it will not trigger when the event occurs. Web hooks become disabled automatically if a ping event fails on create or update. They need to be manually re-enabled if this occurs.

## Retry policy

In the event of a failed web hook request (due to timeout, a non HTTP 200 response, or network issues), Greenhouse will attempt a maximum of 24 retries with exponential backoff according to this formula:

`5 + (retry number) ^ 4` seconds relative to the last attempt

| Retry number | Time since last retry | Time since original attempt
|--------------|-----------------------|----------------------------
| 1 | 6 seconds | 6 seconds
| 2 | 21 seconds | 27 seconds
| 3 | 86 seconds | 113 seconds
| 8 | 68.4 minutes | 2.4 hours
| 12 | 5.8 hours | 16.9 hours
| 20 | 44.4 hours | 8.3 days
| 24 | 92.1 hours | 20.4 days
In the event of a failed web hook request (due to timeout, a non HTTP 200 response, or network issues), Greenhouse will attempt a maximum of 12 retries with exponential backoff according to this formula:
`(retry_count ** 4) + 15 + (rand(30) * (retry_count + 1))` (i.e. 15, 16, 31, 96, 271, ... seconds + a random amount of time). It will perform 12 retries over approximately 12 hours.

This table contains approximate retry waiting times:

| Retry number | Next retry backoff | Total waiting time |
|---| -------------------| -------------------- |
| 1 | 0d 0h 0m 30s | 0d 0h 0m 30s |
| 2 | 0d 0h 0m 46s | 0d 0h 1m 16s |
| 3 | 0d 0h 1m 16s | 0d 0h 2m 32s |
| 4 | 0d 0h 2m 36s | 0d 0h 5m 8s |
| 5 | 0d 0h 5m 46s | 0d 0h 10m 54s |
| 6 | 0d 0h 12m 10s | 0d 0h 23m 4s |
| 7 | 0d 0h 23m 36s | 0d 0h 46m 40s |
| 8 | 0d 0h 42m 16s | 0d 1h 28m 56s |
| 9 | 0d 1h 10m 46s | 0d 2h 39m 42s |
| 10 | 0d 1h 52m 6s | 0d 4h 31m 48s |
| 11 | 0d 2h 49m 40s | 0d 7h 21m 28s |
| 12 | 0d 4h 7m 16s | 0d 11h 28m 44s |

Note: This table was calculated under the assumption that `rand(30)` always returns 15.