Standard Schedule Integration Flow

To schedule a interview in Talview Workflow Tools (WFT) application,please follow the below steps.

Prerequisites

An workflow with Technical Round needs to be pre configured.

Interview Schedule Technical Steps

1. Authentication

Use this guide to generate an access_token.
The token generated will go in Authorization header for all API calls.

2. Schedule API

Every invitation send to Talview System, must follow below the payload structure. Request header definition:

Method	POST
Host	https://api.talview.com
Route	/api/rest/external/workflow/schedule
Content type	application/json

Request payload definition: Standard

Attribute	Mandatory	Data Type	Description
organizer_email	yes	String	Organizer of interview email address
interviewers	yes	Array of String	Array of emails of the interviewers
candidate_email	yes	String	Candidate’s email address
candidate_reference_id	yes	String	Candidate’s ID in External System
timezone	no	String	The timezone to be used for the schedule
candidate_name	no	String	Candidate’s name (first + last ) name
start_time	yes	timestampz	Start time of the interview. ISO 8601 format: yyyy-MM-dd’T’HH:mm:ss.SSSZ
status	yes	String	Status to manage schedule: Possible values: 1. SCHEDULE 2. CANCEL 3. UPDATE
callback_url	yes	String	Url of External Service to be used for sending the reports,scores,playbacy video,etc..
duration	yes	Number	Duration of interview in minutes Possible values: 30 \| 45 \| 60 \| 90 \| 120, default: 30
meeting_id	no	Number	Meeting_id in Talview System (Used when doing CANCEL/UPDATE actions)
workflow_step_id	yes	String	Talview Workflow ID
workflow_step_reference_id	no	String	WorkflowStep ID from external client system ( Note : Need to send either workflow_reference_id or workflow_step_reference_id )

Sample response payload:

Success response: HTTP status code - 201

{
  "meeting_id": 1293,
  "candidate": { "external_id": 2932, "email": "abc@xyz.com" },
  "meeting_status" : "SCHEDULED"
}

Error response: HTTP status code - 422

{
	"errors": [{
		"field": "start_time",
		"message": "Start time cannot be in the past"
	}]
}

Error response: HTTP status code - 400

{
	"errors": [{
		"field": "start_time",
		"message": "Start time cannot be blank"
	}]
}

Sample CURL request:

curl --request POST \
  --url https://api.talview.com/api/rest/external/workflow/schedule \
  --header 'Authorization: Bearer <:access_token:>' \
  --data '{
   "status": "SCHEDULE",
   "meeting_id": null,
   "workflow_step_id": "39121",
   "start_time": "2024-06-08T08:30:00.000Z",
   "duration": 30,
   "timezone": "Asia/Kolkata",
   "candidate_name": "candidate name",
   "candidate_email": "candidate@email.com",
   "candidate_reference_id": "CAN_LAT_10045",
   "interviewers": ["inerviewer1@email.com", "inerviewer2@email.com"],
   "organizer_email": "organizer@email.com",
   "workflow_step_reference_id" : "LA-1-1",
   "callback_url" : "https://<external_service_host_url>.com/scores"
}'

Configurations

Login & Access

Forms

Standard Schedule Integration Flow

Prerequisites

Interview Schedule Technical Steps

1. Authentication

2. Schedule API

​Prerequisites

​Interview Schedule Technical Steps

​1. Authentication

​2. Schedule API

Prerequisites

Interview Schedule Technical Steps

1. Authentication

2. Schedule API