Events

CookieBoss dispatches events whenever a visitor makes a consent choice. Use these to conditionally load scripts, update your UI, or integrate with tag managers.

cookieboss:update CustomEvent

A CustomEvent is dispatched on document every time consent changes (accept all, reject all, or custom selection):

document.addEventListener('cookieboss:update', (event) => {
const categories = event.detail.categories;

console.log('Consent updated:', categories);
// { necessary: true, analytics: true, marketing: false, functional: true }

if (categories.analytics) {
  // Initialize analytics
}

if (categories.marketing) {
  // Load marketing pixels
}
});

Event detail shape

GTM dataLayer events

If GTM integration is enabled in your dashboard, CookieBoss automatically pushes events to window.dataLayer:

Event names

dataLayer payload

{
event: "cookieboss_consent_update",
cookieboss: {
  siteId: "01KHJTD0CZG42333Z4P3F6X7Z4",
  consent: {
    necessary: true,
    analytics: true,
    marketing: false,
    functional: true
  }
}
}

Using in GTM

1. Create a Custom Event trigger for cookieboss_consent_update
2. Create Data Layer Variables to read cookieboss.consent.analytics, cookieboss.consent.marketing, etc.
3. Add firing conditions to your tags (e.g. only fire Google Analytics when cookieboss.consent.analytics equals true)

See the full GTM Integration guide for step-by-step instructions.

Listening on page load

The cookieboss:update event fires when the visitor interacts with the banner. If you need to check consent on initial page load (e.g. for a returning visitor who already consented), use getConsent():

// On page load: check existing consent
document.addEventListener('DOMContentLoaded', () => {
if (window.__cookieboss) {
  const consent = window.__cookieboss.getConsent();
  if (consent.analytics) {
    initAnalytics();
  }
}
});

// On consent change: react to updates
document.addEventListener('cookieboss:update', (event) => {
if (event.detail.categories.analytics) {
  initAnalytics();
}
});