Overview

Deployments define how your Begini assessments are configured, delivered and managed.

They act as the foundation for both:

• No-code link generation
• API-based integrations

A well-structured deployment setup ensures consistency, scalability and clear reporting.

---

What is a deployment

A deployment is a configuration layer that controls:

• The assessment experience
• The data collected
• The behaviour of the session
• How results are generated

Each deployment is tied to a specific use case or product flow.

---

Why deployments matter

Using deployments correctly allows you to:

• Separate different products or loan types
• Test different configurations
• Control how users experience the assessment
• Track performance across segments

Without clear deployment structure, reporting and scaling become difficult.

---

Creating a deployment

Within the Beacon Dashboard:

1. Navigate to Deployments
2. Select Create new deployment
3. Configure the required settings
4. Save the deployment

Once created, the deployment can be used for:

• Link generation
• API session creation

---

Key configuration considerations

When creating a deployment, you should consider:

Use case

• What product or journey is this for?
• Is this for testing or production?

---

Naming convention

Use clear and consistent naming.

Example:

• Personal Loans - Production
• SME Lending - Pilot
• Test - Internal QA

---

Environment

Ensure the deployment is created in the correct environment:

• Sandbox for testing
• Production for live usage

---

Using deployments

No-code (Link Generator)

• Select deployment
• Generate links
• Distribute to users

Each link is tied to that deployment configuration.

---

API integration

When creating sessions via API, you reference:

• Integration ID
• Deployment configuration (implicitly applied)

This ensures consistent behaviour across all sessions.

---

Managing multiple deployments

As you scale, you may have multiple deployments.

Common examples:

• Different countries
• Different products (e.g. personal vs SME loans)
• Different testing phases

Best practice:

• Keep deployments clearly separated
• Avoid duplicating similar configurations unnecessarily
• Use naming to distinguish purpose

---

Updating deployments

You may need to update deployments over time.

Examples:

• Adjusting assessment configuration
• Updating flows or parameters
• Refining based on performance

Important:

• Understand how changes affect live sessions
• Test updates in sandbox before applying to production

---

Common mistakes

• Creating too many unclear deployments
• Using inconsistent naming
• Mixing test and production deployments
• Making changes without testing

---

Best practices

• Use structured naming conventions
• Separate deployments by use case
• Test before production rollout
• Review deployment performance regularly

---

Relationship to other components

Deployments are used across:

• Link Generator (no-code)