Web JS API Reference

Last updated: July 1, 2026

This reference covers documented public browser APIs for CYBEXO Web CMP Engine deployments.

1. Initialize CMP

window.initCybexoCMP(options?)

Purpose:

• initializes the CYBEXO CMP runtime when using a supported manual initialization path

Most customers should use the loader script, GTM template, or CMS plugin rather than calling this directly.

2. Show CMP UI

window.showCMPBanner(force?)

Purpose:

• opens or reopens the CMP UI

Parameters:

• force (boolean, optional): when true, reopens UI even if prior consent exists

Example:

window.showCMPBanner?.(true);

3. Open Preferences

window.openCMPSettings()

Purpose:

• opens the second-layer preferences modal directly when the runtime is ready

Example:

if (window.openCMPSettings) {
  window.openCMPSettings();
} else {
  window.showCMPBanner?.(true);
}

4. Report Conversion

window.cybexoReportConversion(detail?)

Purpose:

• records a consent-aware conversion signal when the runtime is available

Example:

window.cybexoReportConversion?.({
  event: "lead_submit",
  value: 1
});

5. TCF API

window.__tcfapi(command, version, callback, parameter?)

Purpose:

• standard IAB TCF API endpoint exposed by the CMP runtime

Common commands:

• ping
• getTCData
• addEventListener
• removeEventListener
• displayConsentUi

Example:

window.__tcfapi("displayConsentUi", 2, () => {});

6. GPP API

window.__gpp(command, callback, parameter?, version?)

Purpose:

• standard IAB GPP API endpoint exposed by the CMP runtime where enabled

Common commands:

• ping
• addEventListener
• removeEventListener
• getGPPData

7. Debug Helper

window.cybexoDebugConsent(showUI?)

Purpose:

• runs runtime diagnostics for Consent Mode ordering, TCF availability, and loader health

Parameters:

• showUI (boolean, optional): when true, opens the debug overlay

Examples:

window.cybexoDebugConsent?.();
window.cybexoDebugConsent?.(true);

8. Notes

• API availability depends on successful loader initialization.
• Keep custom calls behind existence checks in production.
• Consent action internals are handled by the CMP UI.