Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
            • Boxever.eventCreate(event, callback, format)
            • Boxever.callFlows(flow, callback)
            • Boxever.addUTMParams(event)
            • Boxever.browserCreate(object, callback, format)
            • Boxever.browserShow(browserId, clientKey, callback, format)
            • Boxever.getBucketNumber([callback])
            • Boxever.getClientKey()
            • Boxever.getCookie(cookieName)
            • Boxever.getID()
            • Boxever.reset()
            • Boxever.setCookie(cookieName, cookieValue[, expiresIn])
            • Boxever.templating()
            • Boxever.triggerExperiences()
        • Troubleshooting
        • Release notes
  1. Functions
  1. Stream API
  2. Functions
  3. Boxever.browserShow(browserId, clientKey, callback, format)

Boxever.browserShow(browserId, clientKey, callback, format)

The browserShow() function retrieves the guest reference from Sitecore CDP.

The guest reference is in the customer.ref key of the parameter that is passed to the callback function.

Parameters

Parameter

Type

Description

Note

browserId

string

The browser ID.

Set the value to Boxever.browser_id.

clientKey

string

The client key.

Set the value to Boxever.client_key.

Or, to bypass authentication, set the value to 0.

callback

function

This callback function handles the response.

The guest reference is in the customer.ref key of the parameter that is passed to the callback function.

format

string

The format of the response.

Set the value to "json". Other formats are not supported.

Return value

undefined

Example

In the callback function, using the customer.ref key, log the guest reference to the console:

Boxever.browserShow(
    Boxever.browser_id,
    Boxever.client_key,
    response => console.log(response.customer.ref),
    "json"
);

// f7aabbca-1c1b-4fc2-be72-3e16294a4f03
If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use