Assessment webhooks #59
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the webhook documentation to reflect new assessment-related events and renames a few section headings and diagrams for clarity.
- Rename “clientworkflow” to “customerworkflow” and Pre-Screen references to Assessments
- Add
assessmentCreatedandassessmentUpdatedevent payload examples - Update Live Interview naming in TOC and section headers; remove outdated full-E2E diagram; tweak README diagram instructions
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/webhooks/index.html | Renamed workflows, updated TOC labels, added new events |
| docs/diagrams/full-e2e-webhooks-flow.drawio | Removed outdated diagram source file |
| README.md | Clarified diagram editing steps and added a note on pages |
Comments suppressed due to low confidence (1)
docs/webhooks/index.html:84
- [nitpick] The TOC entry reads 'Events for CodeSignal Interviews' but the detailed section headings still use 'Live Interviews'. Consider adding 'Live' to the TOC or removing it from the section titles for consistency.
<li>Events for CodeSignal Interviews</li>
| @@ -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> | |||
There was a problem hiding this comment.
Hmm customer sounds a bit weird, I feel like this change wasn't really necessary 🤔
There was a problem hiding this comment.
Could you elaborate on this? I feel like "organization user" might've been confusing since it's not clear what "organization" we're talking about (as in, CodeSignal or customer), while "customer" does not leave any space for ambiguity.
There was a problem hiding this comment.
Yeah I guess that makes sense, though I think we use organization user a lot. Maybe it's just my interpretation since we say customer to refer to the whole company internally sometimes.
There was a problem hiding this comment.
Maybe it's just my interpretation since we say customer to refer to the whole company internally sometimes.
Ah, yeah, that's what I was going for here 😅
Related to https://github.com/CodeSignal/codesignal/issues/36369. Updates webhook documentation according to the latest webhook changes.
CC @sylvialin22 for context.