Send interview alerts

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Enable our new validation for Interview Alerts scheduling

Before integrating with this API surface, enable the following setting so requests are validated consistently

Navigation
- Settings → Client Setup → Integrations
Toggle
- Enable Validation for Interview Alerts Scheduling
Effect
- New Public API scheduling requests for interviews are validated (optional attendees, attendee counts, required roles, and related rules).

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 BREAK = 19 (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

Body Params

OID

int32

Paradox candidate application ID. (max length :20 )

ex_id

string

An external candidate ID (max length :255 )

job_application_id

string

A candidate's external job application ID. (max length: 255 )

use_application_id_for_identity

boolean

Use the candidate’s Job Application ID as their unique identifier. Using this parameter will allow for candidates to be created and scheduled from this endpoint.

action

string

required

Defaults to interview

The action of interview: "interview" (send interview times to candidate), "reschedule" (reschedule the interview), "cancel" (cancel the interview) (max length: 10)

interview_duration

int32

required

Interview duration in minutes. The maximum amount of time is 415 minutes and the minimum is 5.

interview_type

int32

required

Defaults to 0

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 BREAK = 19 (max length: 6)

custom_interview_type

string

The API ID of the custom interview type

interview_segments

array of objects

Interview parameters for each segment of a sequential interview. This parameter can only be used when a sequential interview_type has been selected.

interview_segments

interviewer_emails

array of objects

List of email address of the interviewer(s). (max length: 255 ) Endpoint will accept either a comma separated list or array of objects.

interviewer_emails

interviewer_ex_ids

array of objects

List of external employee IDs of the interviewer(s). Ex : ["e5464656","2523525"] (max length of employee id: 255) Endpoint will accept either a comma separated list or array of objects. When using the objects to specify which interviewers are optional the "Enable Validation for Interview Alerts Scheduling" toggle must be turned on

interviewer_ex_ids

interview_team

string

A dynamic round-robin group based on receiving a list of either user emails or employee IDs. Ex '["u_1234", "2523525", "[email protected]"]'. It can have up to a maximum of 25 interviewers. User's priority is High

alternate_interview_team

string

interviewer_ids

array of objects

List of Paradox IDs to identify the interview attendees. Ex:["u_636","u_74","g_6","exg_1089"] = User ID 636 and 74 and Round Robin Group ID = 6 and External Group ID = 1089 . (max length of user id: 10). Endpoint will accept either a comma separated list or array of objects.

interviewer_ids

interview_jobloc_code

string

The external location ID of the interview job location.

interview_jobloc_room_id

int32

The Paradox id of the interview room. If -1 is sent as the value, the Paradox logic of “Any Available Room” will be utilized.

interview_jobloc_id

int32

The Paradox ID of the interview job location.

interview_location_address

string

A valid street address to be used for the interview location. This does not have to be an existing location in the Paradox environment.

interview_instructions

string

This is Interview Instructions (max length : 320)

candidate_interview_prep_ex_id

string

The Interview Prep External ID of the candidate (max length: 255 )

recruiter_interview_prep_ex_id

string

The Interview Prep External ID of the recruiter (max length: 255 )

interview_owner_email

string

The interview owner’s email address (max length: 255 ). If no interview owner is provided, the user tied to the API credentials will be used.

generate_virtual_url

boolean

Defaults to false

Generate a virtual interview URL for this interview

private

int32

Defaults to 0

The privacy setting of an interview: 0 = Public, 1 = Private. If this field is not included the account default will be used.

first_name

string

Candidate first name. (max length of name : 50 )

last_name

string

Candidate last name. (max length of name : 50 )

phone

int32

Candidate phone number. (max length: 20 )

string

Candidate email address. (max length: 50 )

job_title

string

Job name. (max length: 255 )

job_req_id

int32

An external Job Requisition ID (max length: 50 )

job_loc_code

string

Location code of job. (max length : 20)

candidate_journey

string

Candidate journey name

candidate_journey_status

string

Candidate journey status ( {Candidate_journey_stage_name}: {Candidate_journey_status_name}

sequential_order_automation

int32

Scheduling order logic ( default : -1 ) (In Order Only) = 0, (In Order, Any Order) = 1, (In Order, Any Order, Multi-Day) = 2, (Multi-Day Only) = 3

recorded_interview_id

string

The external id of recorded interview

interview_jobloc_room_ex_id

string

The external id in job loc room

interview_jobloc_room_email

string

The room email in job loc room

resume

string

Binary/Base64 String Resume file (.pdf, .doc', .docx, .png, .jpg', .txt') (Must be <10mb)

force_sequent_multi_days

boolean

Defaults to false

To make the sequent interview multiple days.

notes_data

string

only apply for is_kenexa_request (is_kenexa_request determine by data has keys ["Sender", "TransactInfo", "Packet"])

note

string

create candidate note

attendee_count

string

Set Number of Attendees for all Round Robin Groups and Interview Team of an Interview

use_paradox_status_map

string

Defaults to false

To identify the use of status_map_name and status_map_ex_id

status_map_name

string

Name of the Journey Status Mapping in Paradox. Required when use_paradox_status_map is true

status_map_ex_id

string

Name of the status in the external system. The ID that is associated with a specific Journey Status in Paradox

primary_contact_method

string

1 = Email, 2 = SMS, 3 = Email & SMS, 4 = WhatsApp & Email, 5 = Whatsapp. Default = Email & SMS

debrief

object

All child properties are required for a debrief.

Headers

Authorization

string

Defaults to Bearer <oauth_token>

Responses

Results

200200

400400