Send test

Creates an assessment instance for a candidate. By default, SmallTalk emails the assessment link to the candidate.

POSThttps://app.smalltalk2.me/api/integration/send_test

Request body

Send a JSON object.

Property	Type	Required	Description
test_id	string	required	Test identifier returned by list_tests.
first_name	string	required	Candidate's first name.
last_name	string	required	Candidate's last name.
email	string	optional	Candidate's email address.
profile_url	string	optional	URL to the candidate's application in the partner system.
callback_url	string	optional	URL notified by POST when the status changes. See callbacks.
no_send_email	boolean	optional	Defaults to false. When true, SmallTalk does not email the candidate and the caller must deliver test_link.
label	string	optional	Text displayed in the interface.
expire	string	optional	Expiration timestamp. Defaults to 10 days from creation.
on_complete_redirect_url	string	optional	URL that receives the candidate after test completion.
proctoring_mode	string	optional	DISABLED or IMAGE_ON_QUESTION. Defaults to DISABLED.

Expiration format

Use an ISO 8601 timestamp with milliseconds and a UTC designator:

2021-02-18T21:54:42.123Z

Proctoring modes

Value	Behavior
DISABLED	Disables proctoring. This is the default.
IMAGE_ON_QUESTION	Captures an image on every question.

Example request

curl -X POST 'https://app.smalltalk2.me/api/integration/send_test' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "test_id": "12345",
    "first_name": "Harry",
    "last_name": "Potter",
    "email": "hpotter@hogwarts.edu",
    "profile_url": "https://example.com/people/17681532",
    "callback_url": "https://example.com/complete"
  }'

Response

Property	Type	Availability	Description
interview_id	string	always	Identifies the candidate's assessment for the test_status endpoint.
test_link	string	always	Link to the candidate's assessment.

{
  "interview_id": "o2jn3r",
  "test_link": "https://app.smalltalk2.me/assessment/?id=o2jn3r"
}