Event types
| `type` | When | Carries |
|---|---|---|
ready | The invitation opened in the frame | invitationId |
login_required | The sign-in code step is shown | invitationId |
started | The interview started | invitationId, sessionId |
completed | The finished screen is shown, or the candidate opened an invitation they had already completed | invitationId, and sessionId when they just finished |
feedback_submitted | The candidate sent the feedback form after the interview (not when they skip it) | sessionId |
error | The interview can't run: the invitation can't be opened, or we're under maintenance | code and message |
Error codes
| `code` | Meaning |
|---|---|
link_invalid | The link is unknown, revoked or replaced by a newer one (resend the invitation) |
link_expired | The invitation expired |
interview_not_open | A New York City notice period: the interview opens later |
company_unavailable | The company can't run interviews right now |
maintenance | We're under maintenance: no new interview starts for now; try again later |
load_failed | Our side or the network failed: try again in a moment |
Branch on code; message is English text for your logs or your own wording, and may change.
The event object
Event
Events carry ids only: never the candidate's name, email, answers or a token. Use the sessionId with the API to fetch results once results.ready arrives.
Handle them
JavaScript
- Not a result.
completedmeans the candidate finished, not that the analysis is ready. Wait for theresults.readywebhook. - No way back when embedded. Inside the frame the finished screen shows no button to an invitation's
returnUrl:completedis your cue to move on. - Trusted messages only. The SDK accepts messages only from its own iframe and the interview's origin. Unknown types are ignored.