put https://api.paradox.ai/api/v1/public/interview/interview_alerts
This API allows 3rd party integrators to send Interview Requests to Paradox. Additionally, this API will create Candidates within Paradox that do not exist.
Results
Calling '/interview/interview_alerts' endpoint.
This is the parameters to alert for an interview
| Key | Description |
|---|---|
| OID | Candidate id |
| action | The action of interview (interview, cancel, reschedule) |
| by_web | 1 if interview by web |
| schedule_time | the Schedule time |
| interview_jobloc_id | the Interview jobloc id |
| interview_duration | the Interview duration |
| interview_type | the Interview type include IN_PERSON_INTERVIEW = 1 PHONE_INTERVIEW = 2 IN_PERSON_MEETING = 3 PHONE_MEETING = 4 SEQUENTIAL_INTERVIEW = 5 SEQUENTIAL_MEETING = 6 VIRTUAL_INTERVIEW = 7 VIRTUAL_MEETING = 8 GROUP_INTERVIEW = 9 PHONE_CONVERSATION = 10 IN_PERSON_CONVERSATION = 11 VIRTUAL_CONVERSATION = 12 IN_PERSON_SESSION = 13 PHONE_SESSION = 14 SEQUENTIAL_SESSION = 15 VIRTUAL_SESSION = 16 GROUP_SESSION = 17 INTERVIEW_PREFERENCE = 18 (max length: 6) |
| interview_instructions | the Interview Instructions |
| interview_jobloc_room_id | the ID of the interview room |
| interviewer_ids | id list of the interviewers |
| ip | ip of the candidate |
| lead_id | id of the candidate |
| using_calendar_popup_page | For all interview web pages using calendar pop up |
The result will:
In case success is 1, the keys as below:
| Key | Description |
|---|---|
| success | 1 |
| interview_data | the error |
| recruiter_text | Recruiter message that send to candidate |
| processed | 1: have sent an alert, 0: not yet |
| company_id | The company id of a candidate |
| candidate | Candidate-specific data(OID) |
In case success is 0, the keys as below:
| Key | Description |
|---|---|
| error | the error message |