Skip to main content
To integrate with Talview WFT (Workflow Tools) Assessment, please follow the steps below.

​
Assessment Invite 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. Assessment Invite API

Every assessment invitation sent to Talview, must follow the below payload structure. Request header definition
MethodPOST
Hosthttps://api.talview.com
Route/api/rest/external/assessment/invite
Content typeapplication/json
Request payload definition: Standard
AttributeMandatoryData TypeDescription
candidate_emailyesStringCandidate’s email address
candidate_first_namenoStringCandidate’s first name
candidate_last_namenoStringCandidate’s last name
candidate_reference_idnoStringCandidate’s ID in the external system
workflow_step_idyesNumberWorkflow_step_id in Talview System
(maps to the exact step in the workflow where the candidate needs to be invited)
workflow_step_reference_idnoStringWorkflow Step ID in the external system
(Note: Either workflow_step_id or step_reference_id is manadatory)
callback_urlnoStringURL of the external service to be used for sending the reports, scores, playback video, etc.
is_notifynoBooleanWhether the candidate needs to be notified or not
valid_tillnoTimeStampzAssessment window duration in ISO 8601 format: yyyy-MM-dd’T’HH:mm:ss.SSSZ
Sample response payload:
  1. Success response: HTTP status code - 201 
    {
  "workflow" : {
    "id" : 12,
    "external_id" : "12-1A",
    "workflow_name": "Java Techincal"
  },
  "candidate": { "external_id": 2932, "email": "[email protected]" },
  "step" : {
    "id": 29103,
    "external_id": "2032-201",
    "type": "ASSESSMENT",
    "workflow_id": 3
  },
  "valid_till": "2025-10-03T17:00:00+00:00",
  "attend_url": "https://cx.talview.com/..."
}
  2. Error response: HTTP status code - 422 
    {
	"errors": [{
		"field": "valid_till",
		"message": "valid till can not be in past"
	}]
}
  3. Error response: HTTP status code - 400 
    {
	"errors": [{
		"field": "callback_url",
		"message": "Callback Url can not be blank"
	}]
}
Sample CURL request: 
curl --request POST \\
  --url https://api.talview.com/external/assessment/invite \\
  --header 'Authorization: Bearer <:access_token:>' \\
  --data '{
  "valid_till": "2024-06-08T08:30:00.000Z",
  "candidate_first_name": "candidate",
  "candidate_last_name" : "name",
  "candidate_email": "[email protected]",
  "candidate_reference_id": "CAN_LAT_10045",
  "workflow_step_id": 10394,
  "workflow_step_reference_id": "AD-1",
  "is_notify": true,
  "callback_url" : "https://<external_service_host_url>.com/scores"
}'