This page lists and describes all the events that webhooks can currently send with respect to the interviews workflow.

We will add more webhook events in the future, so make sure you check this page whenever you want to add functionality that depends on the interviews workflow events that can take place in your account.

Webhooks events

1) Candidate joined the interview

This webhook event gets triggered when the candidate joins the interview session.

webhook_event_type: The value of webhook_event_type field would be CANDIDATE_JOINED_INTERVIEW

webhook_payload: This would be a JSON, containing interview_id, candidate_email and joined_datetime fields.

Sample webhook_payload

{
    "interview_id": "619c63e9732e4298be5b47a2f94c2f49",
    "candidate_email": "alice@bob.com",
    "joined_datetime": "2019-08-05T10:11:46-05:51"
}

interview_id

Type: String

Description: This would be the universally unique identifier (UUID) of the interview.

candidate_email

Type: String

Description: This would be the email ID of the candidate who joined the interview.

joined_datetime

Type: String

Description: This would be the timestamp at which the candidate joined the interview. It would be in ISO8601 date-time format.

2) Interviewer joined the interview

This webhook event gets triggered when an interviewer joins the interview session.

webhook_event_type: The value of webhook_event_type field would be INTERVIEWER_JOINED_INTERVIEW

webhook_payload: This would be a JSON, containing interview_id, interviewer_email and joined_datetime fields.

Sample webhook_payload

{
    "interview_id": "619c63e9732e4298be5b47a2f94c2f49",
    "interviewer_email": "alice@bob.com",
    "joined_datetime": "2019-08-05T10:11:46-05:51"
}

interview_id

Type: String

Description: This would be the universally unique identifier (UUID) of the interview.

interviewer_email

Type: String

Description: This would be the email ID of the interviewer who joined the interview.

joined_datetime

Type: String

Description: This would be the timestamp at which the interviewer joined the interview. It would be in ISO8601 date-time format.

3) Interview ended

This webhook event gets triggered when an interview gets ended.

webhook_event_type: The value of webhook_event_type field would be INTERVIEW_ENDED

webhook_payload: This would be a JSON, containing interview_id and end_datetime fields.

Sample webhook_payload

{
    "interview_id": "619c63e9732e4298be5b47a2f94c2f49",
    "end_datetime": "2019-08-05T10:11:46-05:51"
}

interview_id

Type: String

Description: This would be the universally unique identifier (UUID) of the interview.

end_datetime

Type: String

Description: This would be the timestamp at which the interview got ended. It would be in ISO8601 date-time format.