Integration ID & Unique ID Guide
Learn how Integration IDs and Unique IDs work, and how they link your system to individual user journeys.
Overview
This guide explains two key identifiers used in Begini:
- Integration ID
- Unique ID
Understanding how these work is essential for correctly linking assessment sessions, users and results within your own system.
Why these IDs matter
Begini operates as part of your wider application or decisioning flow.
To ensure results are correctly associated with the right user and configuration, two identifiers are used:
- The Integration ID defines which Begini setup is being used
- The Unique ID defines which user the assessment belongs to
Without these, it becomes difficult to reliably connect Begini outputs to your internal systems.
What is an Integration ID
The Integration ID identifies a specific Begini deployment or configuration.
Each deployment in Beacon has its own Integration ID, which ensures that:
- The correct assessment configuration is used
- The correct scoring model is applied
- Results are generated using the intended setup
You will typically use the Integration ID when:
- Creating assessment sessions
- Generating links
- Integrating via API
In simple terms:
What is a Unique ID
The Unique ID is used to identify the end user within your own system.
This allows you to:
- Link an assessment session to a specific user
- Match results back to your internal records
- Track users across multiple interactions if required
Examples of a Unique ID include:
- Customer ID
- Application ID
- Internal reference
In simple terms:
How they work together
The Integration ID and Unique ID are always used together as part of the assessment flow.
- The Integration ID defines the configuration
- The Unique ID defines the user
Together, they ensure that:
- The right assessment is delivered
- The result is linked to the correct individual
- Your internal systems can reliably consume and use the output
Where you will use these IDs
You will encounter these identifiers in several parts of the Begini workflow.
Link Generator (no-code)
When generating assessment links:
- The Integration ID is tied to the selected deployment
- The Unique ID is assigned per generated link
Each link represents a unique session tied to a specific user.
API integration
When integrating programmatically:
- The Integration ID is included when creating a session
- The Unique ID is passed as part of the request
This ensures results can be matched back to your system automatically.
Webhooks and results
When results are returned:
- The Unique ID is included in the response
- This allows you to match the result to the correct user record
This is particularly important for real-time decisioning workflows.
Best practices
To ensure reliable integration, follow these guidelines:
- Always use a stable and unique identifier for the Unique ID
- Do not reuse the same Unique ID across different users
- Ensure your system can map the Unique ID back to internal records
- Keep Integration IDs consistent with the correct deployment
- Test ID handling before moving to production
Common issues
Some common problems that occur when IDs are not handled correctly include:
- Results not matching the correct user
- Duplicate or overwritten records
- Incorrect deployment being used
- Difficulty tracing assessments in Beacon
These are usually resolved by reviewing how Integration ID and Unique ID are being assigned and used.
Next steps
Now that you understand how identifiers work, you can move forward with integration and testing.
See:
- Integration Overview
- Quick Start Guide
- Webhooks Overview
- Go Live Checklist
Was this article helpful?
Give feedback