Skip to content

Documentation

How to Add a Cookie Banner on a Gatsby Website

How to Add a Cookie Banner on a Gatsby Website

Last updated Mar 15, 2026

This guide shows you how to add the Kukie.io cookie consent banner to your Gatsby website. Gatsby uses a special SSR hook to inject scripts into the HTML head at build time.

Prerequisite: You need a Kukie.io account and at least one site added. If you haven't done this yet, follow Create Your Account & Add Your First Site first.

Step 1: Get Your Embed Code

Log in to your Kukie.io dashboard, navigate to your site, and copy the embed code from the Setup tab. It looks like this:

<script src="https://cdn.kukie.io/s/YOUR-SITE-KEY/c.js" async></script>

Replace YOUR-SITE-KEY with the actual site key shown in your dashboard.

Step 2: Add the Script to Gatsby

Gatsby doesn't have a traditional index.html file. Instead, use the gatsby-ssr.js (or gatsby-ssr.tsx) file to inject the script into the HTML head:

// gatsby-ssr.js
import React from 'react'

export const onRenderBody = ({ setHeadComponents }) => {
    setHeadComponents([
        <script
            key="kukie"
            src="https://cdn.kukie.io/s/YOUR-SITE-KEY/c.js"
            async
        />
    ])
}

Run gatsby build or restart gatsby develop for the change to take effect. The script will be included in every page's HTML.

Gatsby Cloud / Netlify / Vercel: No special configuration needed for hosting platforms. The script tag is baked into the HTML at build time and works everywhere.

Step 3: Verify the Installation

Visit your website in a new browser window (or incognito/private mode). You should see the Kukie.io consent banner appear. If it does not show, check the following:

  • Open your browser's Developer Tools (F12) and look for the script in the Network tab — it should load with a 200 status
  • Check the Console tab for any JavaScript errors
  • Make sure you published/saved your changes in your Gatsby site
  • Clear any platform-level cache if applicable

For a detailed verification walkthrough, see How to Verify Your Banner Installation.

Next Steps

Need help? If you run into any issues, contact our support team and we'll help you get set up.

Was this helpful?