Overview

A deployment is the configuration layer that controls how your Begini assessment is delivered. Every session created via API and every link generated via the Link Generator is tied to a specific deployment. Getting your deployment structure right early makes reporting, scaling, and troubleshooting significantly easier.

What a deployment controls

Each deployment has independent settings for Test and Production environments, including:

• Integration ID and API key
• Session time limit (default 24 hours, configurable 1–10,000 hours)
• Assessment use case and device type
• Branding (logo and colours)
• Redirect URLs for completion, cancellation, and expiry events
• Webhook endpoint URL

Changes to one environment do not affect the other. Configure Test and Production settings separately.

Creating a deployment

In Beacon → Deployment Centre → Create new deployment. Once created, the deployment appears in the list and can be selected for link generation or API integration.

Use a clear, consistent naming convention from the start. Examples:

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

Vague names like "Deployment 1" make reporting and debugging much harder as you scale.

Configuring redirects

When a user finishes the assessment journey, Begini redirects them to one of three URLs depending on the outcome:

Configure these in Beacon → Deployment Centre → select deployment → Test or Production tab → Redirects section. If you do not set your own URLs, Begini's default screens are shown — these create a dead end in your user journey. Always configure your own redirect URLs for production.

Branding

The assessment is fully white-labelled. Configure in Beacon → Deployment Centre → select deployment → Branding:

• Logo — must be 500×120px, PNG format, transparent background, horizontal layout
• Colours — primary colour (used throughout the UI) and secondary colour (header and timer), set by hex code

Changes must be applied to Test and Production deployments separately.

Important: Any changes to branding — logo, colours, or other settings — must be applied to the Test and Production deployments separately. Changes made in one environment are not carried over to the other.

Session time limit

Controls how long a session link remains valid after creation. Default is 24 hours. Configurable from 1 to 10,000 hours. The timer starts when the session API is called. If a user returns after the session has expired, they are redirected to your configured expiry URL.

Expired sessions can be re-opened via the Beacon results screen (Re-try action), which restarts the timer.

Before going live

Confirm the following in the Production tab of every deployment you are launching:

• Correct redirect URLs configured
• Webhook endpoint URL set and verified (use the test API)
• Branding applied
• Session time limit appropriate for your use case
• Production API key and Integration ID in your integration code

Next steps

• Test & Production Environments — keep environments cleanly separated
• Go Live Checklist — full pre-launch readiness checklist
• Using The Beacon Dashboard — operational guide to Beacon