Getting Public Links
The getPublicLink Function
Use the getPublicLink SDK function to generate a shareable URL that external viewers can access without authentication.
Basic Usage
Upscope("getPublicLink", {
agentId: "agent-unique-id",
agentName: "Agent Name"
}, function(link) {
console.log("Share this link: " + link);
});
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
agentId | string | Yes | A unique identifier for the agent (e.g., user ID from your system) |
agentName | string | Yes | Display name shown to viewers |
Callback Response
The callback receives a URL string that viewers can open directly in their browser.
Example link format: https://company.helloscreen.com/123456
Custom Domain
If you want to change your company domain, please contact support.
Displaying the Link
Here's an example of how you might display the link in your UI:
function displayLink() {
Upscope("getPublicLink", {
agentId: currentUser.id,
agentName: currentUser.name
}, function(link) {
document.getElementById("public-link").textContent = link;
document.getElementById("link-container").style.display = "block";
});
}