Custom Landing Page Options for ScreenMeet Session Links
Overview
A custom landing page lets your organization send end users to a branded page on your own website before they join a ScreenMeet Remote Support or Live session. This article explains how ScreenMeet builds session links, the setup options available for a hosted landing page, and the requirements your page must meet for each option.
This article is for web teams, IT administrators, and Salesforce administrators planning a branded entry point for ScreenMeet sessions. For subdomain and fully custom domain options, see Remote Support Custom Domains.
Prerequisites
A page hosted on your website where end users enter their 6-digit session PIN.
Access to your web team to change the page's code and, for some options, the web server or DNS configuration.
A ScreenMeet support ticket to request the configuration change for your organization.
How ScreenMeet Session Links Work
ScreenMeet uses two addresses for each session. ScreenMeet support sets both for your organization.
Address | Purpose | Default |
|---|---|---|
Session link | A link that includes the session PIN. ScreenMeet adds the PIN to the end of the base address when a session is created, for example |
|
Join by PIN URL (Help URL) | An address shown to agents that they read out to the end user. The end user opens it and types the PIN. No PIN is added. |
|
The myhelpscreen.com page validates the PIN and routes the end user to the correct experience: the client download for Remote Support, or the browser session for Live. Every option in this article keeps myhelpscreen.com as that routing step.
How the Salesforce Component Displays Session Links
The ScreenMeet console shows the session link and the Join by PIN URL separately. The ScreenMeet component in Salesforce works differently. When a custom Join by PIN URL is set, the component builds its Link field from the hostname of that custom address plus the PIN, and any path is not included.
For example, a custom address of www.example.com/support/ produces a Link value of www.example.com/123456. The component does not show a separate myhelpscreen.com link alongside the custom address.
Custom Address Applies to Every Agent
The custom address is set for the whole ScreenMeet organization. If the resulting Link value does not open a working page, every agent who copies that link or uses Copy invite sends end users to a broken address.
Choosing an Option
Choose an option based on how agents will direct end users to your page and where the page is hosted.
Option | Best for | Changes on your side | ScreenMeet configuration |
|---|---|---|---|
Option A: Manual PIN entry page | Agents read out your page address and the PIN | None beyond the existing page | None required |
Option B: Dedicated hostname | Agents send links that open your page with the PIN filled in | Host the page at the root of its own hostname, add a rewrite rule, and add PIN-reading code | Session link and Join by PIN URL set to your hostname |
Option C: Page on a path of an existing site | Pages that must stay at an address such as | Add PIN-reading code | Supported in the ScreenMeet console. Not currently supported for links shown in the Salesforce component |
Option A: Manual PIN Entry Page
In this option, agents give end users your page address and the session PIN. The end user opens your page, types the PIN, and your page sends them to myhelpscreen.com to join the session. This option works for both Remote Support and Live sessions.
Confirm your page redirects a valid 6-digit PIN to
https://myhelpscreen.com/<PIN>.Train agents to give end users your page address and the PIN instead of the session link.
Leave the ScreenMeet session link at its default so the Link field in Salesforce continues to work.
Showing Your Page in the Agent Widget
ScreenMeet can show your page as the Join by PIN URL. In Salesforce, this also changes the Link field as described in How the Salesforce Component Displays Session Links. Only request this change if your page works at the resulting address.
Option B: Dedicated Hostname
In this option, your page is hosted at the root of its own hostname, for example support.example.com. Session links take the form support.example.com/123456, which matches how both the ScreenMeet console and the Salesforce component build links. No changes to ScreenMeet are required.
Step 1: Host the Page at the Root of a Hostname
Create a DNS record and TLS certificate for the hostname.
Serve your landing page at the root path
/of that hostname.Configure your web server to return the same page for any path that is exactly six digits, for example
/123456. Other paths can return your normal 404 page.
Step 2: Add Code That Reads the PIN
Add a script that reads the PIN from the address and fills in your PIN field. Replace pinInput with the ID of your page's PIN field.
<script>
function getPinFromUrl() {
var match = location.pathname.match(/\/(\d{6})\/?$/) || location.hash.match(/(\d{6})/);
return match ? match[1] : null;
}
function connectToSession(pin) {
if (/^\d{6}$/.test(pin)) {
window.location.href = "https://myhelpscreen.com/" + encodeURIComponent(pin);
}
}
document.addEventListener("DOMContentLoaded", function () {
var pin = getPinFromUrl();
if (pin) {
document.getElementById("pinInput").value = pin;
}
});
</script>If your page requires the end user to accept terms before connecting, call connectToSession(pin) after acceptance instead of on page load.
Step 3: Request the ScreenMeet Configuration Change
Open a ScreenMeet support ticket with your hostname. ScreenMeet support sets the session link to https://<your-hostname>/ and the Join by PIN URL to <your-hostname> for your organization.
Test Before Production
Ask ScreenMeet support to apply the change to a test organization first. Confirm the links work for both Remote Support and Live before the change is applied to production.
Option C: Page on a Path of an Existing Site
If your page must stay on a path of an existing site, such as www.example.com/support/, ScreenMeet can add the PIN after a # character, for example www.example.com/support/#123456. The # keeps the request on your page, and the script in Option B reads the PIN from it.
Salesforce Component Limitation
The ScreenMeet component in Salesforce does not currently keep the path when it builds its Link field. Until this changes, use Option A or Option B if agents launch sessions from Salesforce.
Sending End Users Directly to the Client Download
Your page can skip myhelpscreen.com and send end users straight to the Remote Support client download by using the Session Download Metadata API. Your page calls GET https://api-v3.screenmeet.com/v3/support/{PIN}/meta, reads client_info.win_download_url or client_info.mac_download_url based on the browser's user agent, adds the PIN to the end of that URL, and redirects the end user to it.
Remote Support Only
The metadata endpoint returns download links for Live PINs as well and does not indicate the session type. If your agents use ScreenMeet Live, do not use direct download. Live end users would receive the Remote Support client instead of joining in the browser.
Verification
Start a Remote Support session and a Live session from the ScreenMeet console and from the Salesforce component.
Open the Link value for each session in a private browser window. Confirm your page loads and the PIN field is filled in.
Open the Join by PIN URL, type the PIN, and confirm the session starts.
Confirm Remote Support end users receive the client download and Live end users join in the browser.