مواد پر جائیں

Embed SDK

Events.

What onEvent receives as the candidate moves through the interview.

آخری اپ ڈیٹ 19 نومبر، 2026

ڈویلپر دستاویزات صرف انگریزی میں دستیاب ہیں۔

Event types

`type`WhenCarries
readyThe invitation opened in the frameinvitationId
login_requiredThe sign-in code step is showninvitationId
startedThe interview startedinvitationId, sessionId
completedThe finished screen is shown, or the candidate opened an invitation they had already completedinvitationId, and sessionId when they just finished
feedback_submittedThe candidate sent the feedback form after the interview (not when they skip it)sessionId
errorThe interview can't run: the invitation can't be opened, or we're under maintenancecode and message

Error codes

`code`Meaning
link_invalidThe link is unknown, revoked or replaced by a newer one (resend the invitation)
link_expiredThe invitation expired
interview_not_openA New York City notice period: the interview opens later
company_unavailableThe company can't run interviews right now
maintenanceWe're under maintenance: no new interview starts for now; try again later
load_failedOur 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
{  "source": "testee",  "version": 1,  "type": "completed",  "invitationId": "inv_mh3m8k1qz8x4pd",  "sessionId": "Qx7vT2mKpL9nWb4sYc1e"}

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
TesteeEmbed.mount({  container: "#interview",  link: invitationLink,  onEvent: (e) => {    if (e.type === "completed") showThankYou();
    if (e.type === "error") showMessage(e.code === "link_expired" ? "Your invitation expired." : e.message);  },});
  • Not a result. completed means the candidate finished, not that the analysis is ready. Wait for the results.ready webhook.
  • No way back when embedded. Inside the frame the finished screen shows no button to an invitation's returnUrl: completed is 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.