Creating an Assessment
Learn how to create sessions via API or generate links for users to start the assessment.
Overview
An assessment session represents a single instance of a user completing the Begini Psychometric Assessment. Each session is uniquely identifiable and links behavioural data, results and user identity back to your system. Sessions can be created using the no-code Link Generator in Beacon or via the Begini API.
Why sessions matter
Every assessment must be tied to a session to ensure results are linked to the correct user, data is tracked consistently, duplicate or conflicting records are avoided, and outputs can be integrated into your decisioning workflow.
Option 1 — No-code: Link Generator
Log in to Beacon and navigate to the Link Generator. Select the deployment you want to use. Enter a name or reference for the batch and choose how many links to generate. Click Generate. Each link is a unique session that can be shared with a user. When the user completes the assessment, results are automatically available in Beacon.
Option 2 — API: Creating a session programmatically
Send a POST request to the session creation endpoint with your API key in the Authorization header. The request body must include the integration_id for your deployment and a unique_id that identifies the user in your system. The response includes a session URL that you redirect the user to. Once the user completes the assessment, results are returned via webhook and are also visible in Beacon.
What happens after the session is created
Once a session is created and the user completes the assessment, Begini processes the behavioural data, a score and risk output are generated, results are available in Beacon, and if webhooks are configured, results are delivered to your endpoint in real time.
If the user does not complete the assessment, the session remains open until it expires. Incomplete sessions do not generate results.
Was this article helpful?
Give feedback