CookieBeam Documentation

Everything you need to implement cookie consent on your website

Quick Start

1. Create Account

2. Add Script

Copy the generated script tag and paste it into your website's HTML.

<script src="//cdn.cookiebeam.com/script.js"></script>

3. Go Live

Your cookie banner is now live! Monitor consent rates and compliance in your dashboard.

Features

GDPR & CCPA Compliance

Built-in compliance with major privacy regulations worldwide.

Customizable Design

Match your brand with custom colors, fonts, and layouts.

GTM Integration

Seamless integration with Google Tag Manager Consent Mode v2.

Real-time Analytics

Track consent rates and user preferences with detailed analytics.

Implementation Guides

Basic Implementation

Step 1: Get Your Script

After creating your banner, copy the script from your dashboard.

<script src="//cdn.cookiebeam.com/banner/YOUR_ID.js"></script>

Step 2: Add to HTML

Place the script tag in your website's <head> section or before the closing </body> tag.

Advanced Configuration

Custom Categories

Configure custom cookie categories and manage granular consent.

Event Callbacks

Hook into consent events to trigger custom actions in your application.

API Integration

Use our REST API to programmatically manage banners and consent data.

API Reference

JavaScript API

CookieBeam.getConsent()

Returns the current consent status for all categories.

const consent = CookieBeam.getConsent();
// Returns: { necessary: true, analytics: false, marketing: true }

CookieBeam.updateConsent()

Programmatically update consent preferences.

CookieBeam.updateConsent({
  analytics: true,
  marketing: false
});

CookieBeam.showBanner()

Manually display the consent banner.

CookieBeam.showBanner();

Platform Integrations

WordPress

Easy integration with WordPress sites using our plugin or manual implementation.

Shopify

Add the script to your Shopify theme for seamless e-commerce compliance.

Google Tag Manager

Configure GTM tags to respect user consent preferences automatically.

Need Help?

Knowledge Base

Browse our comprehensive guides and tutorials.

Community

Join our community forum for discussions and tips.

Contact Support

Get direct help from our technical support team.