---
title: "Connect SitecoreAI CMS to Scrunch"
slug: "connect-sitecoreai-cms-to-scrunch"
abstract: "Connect your SitecoreAI CMS environment to Scrunch to enable signals in SitecoreAI."
---
# Connect SitecoreAI CMS to Scrunch

> [!important]
> **Automatic connection to Scrunch**
>
> This topic describes how to manually connect SitecoreAI CMS to Scrunch. As part of the [Scrunch trial](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/scrunch-trial.html), starting November 12, 2026, SitecoreAI CMS automatically connects to Scrunch. Manual setup is no longer required. This page remains available as a reference for organizations that connected manually before November 12, 2026.

By connecting your SitecoreAI CMS environment to Scrunch, SitecoreAI organization members can start working with signals and AEO opportunities directly in the CMS. Connecting involves the following steps:

:::walkthrough
1. [Provision a Scrunch API key](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/connect-sitecoreai-cms-to-scrunch.html#provision-a-scrunch-api-key)
2. [Add the API key in SitecoreAI Deploy](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/connect-sitecoreai-cms-to-scrunch.html#add-the-api-key-in-sitecoreai-deploy)
:::

> [!note]
> **Before you begin**
> - Make sure you have a SitecoreAI CMS license and a Scrunch license.
> - In SitecoreAI, you must be an *Organization Admin* or *Organization Owner* in your Cloud Portal organization to create environment variables in the Deploy app.
> - In Scrunch, you must have a brand, have the *Organization Admin* role, and be on an eligible Scrunch plan. For more information about prerequisites, see the [Scrunch documentation](https://developers.scrunch.com/getting-started/authentication).
> - Make sure the domain configured for your Scrunch brand matches a domain ([hostname or target hostname](https://doc.sitecore.com/sai/en/users/sitecoreai/create-and-manage-sites/manage-sites.md#manage-hosts)) configured for your SitecoreAI CMS environment. SitecoreAI only displays Scrunch data for matching domains.
>   - Find your domain in Scrunch in **Brand Settings** > **Configure** > **Brand Entities** > **Primary Brand** > **Edit brand** > **Brand Website** or **Alternative Brand Websites**.
>   - Find your domain in SitecoreAI in **Channels** > your site's **Dashboard** > **Settings** > **Site hosts** > **Edit** > **Hostname** or **Target hostname**.
>   - Example domain: `www.my-site.com`

## Provision a Scrunch API key

To provision a Scrunch API key:

1. Log in to Scrunch.
2. In the upper-left corner of the dashboard, click your organization name in the header bar.
![Click your organization name in the header bar to open the Organization settings page](https://doc.sitecore.com/api/markdown-image/sai/en/users/sitecoreai/images/scrunch-org-dashboard.png)
This opens the **Organization** settings page, where you can manage organization-level resources such as Brands, Members, and API keys.
3. In the side navigation, in the **Organization** section, click **API Keys** > **New API key**.
![In the side navigation, in the Organization section, click API Keys > New API key](https://doc.sitecore.com/api/markdown-image/sai/en/users/sitecoreai/images/scrunch-new-api-key.png)
4. In the **Name** field, enter a descriptive name for the API key, such as *Scrunch-SitecoreAI-CMS*.
5. In the **Scopes** field, select **Query**.
6. In the **Limit to brands** field, select one brand to limit the API key to.
7. Click **Create API Key**.
8. Copy the API key because you won't be able to view it in Scrunch again.

> [!important]
> **Best practice**
> - Limit each API key to a single brand, and use the **Query** scope only. If a key is associated with more than one brand, SitecoreAI can't determine which brand to use and the connection fails.
> - Use only one Scrunch API key per SitecoreAI organization. Within that organization, add the API key to only one environment.

## Add the API key in SitecoreAI Deploy

Next, you add the Scrunch API key to a single environment in your SitecoreAI organization in the Deploy app.

To add the API key:

1. Log in to your [Sitecore Cloud Portal](https://portal.sitecorecloud.io/) organization.
2. Open SitecoreAI Deploy and click **Projects** > your project > **Authoring environments** > your environment > **Variables** > **Add variable**.
3. In the **Name** field, you must enter *AI_DISCOVERY_API_KEY*. The connection requires this exact name.
4. In the **Value** field, enter your Scrunch API key.
5. Switch on the **Secret** toggle.
6. Click **Save**.
7. Click **Options** > **Open Dashboard**. Your site's **Strategy** page opens.
    A **Signals** widget appears on the page. In addition, the **AEO opportunities** tab appears on your site's **Channels** page.

This confirms that you've successfully connected your SitecoreAI CMS environment to Scrunch. SitecoreAI organization members can now start working with [signals](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/signals.html) and [AEO opportunities](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/aeo-opportunities.html).

## Troubleshooting

SitecoreAI CMS and Scrunch are not connected if:
- The **Signals** widget doesn't appear on the **Strategy** > **Overview** page of the SitecoreAI environment where you added the Scrunch API key.
- The **AEO opportunities** tab doesn't appear on the **Channels** dashboard page of the SitecoreAI environment where you added the Scrunch API key.

To fix the issue, make sure that:
- Your Scrunch API key is valid.
    The API key is valid if it's limited to a single brand, uses only the **Query** scope, and is not expired or revoked.
- You entered the API key correctly in SitecoreAI Deploy. If the issue persists, create a new API key in Scrunch and add it in SitecoreAI Deploy.
- You use only one Scrunch API key per SitecoreAI organization. Within that organization, add the API key to only one environment.
- The SitecoreAI Deploy environment variable name is *AI_DISCOVERY_API_KEY*. The connection requires this exact name.
- The domain configured for the Scrunch brand matches a domain configured for the SitecoreAI CMS environment. Make sure the two match:
  - Find your domain in Scrunch in **Brand Settings** > **Configure** > **Brand Entities** > **Primary Brand** > **Edit brand** > **Brand Website** or **Alternative Brand Websites**.
  - Find your domain in SitecoreAI in **Channels** > your site's **Dashboard** > **Settings** > **Site hosts** > **Edit** > **Hostname** or **Target hostname**.

If the widget or tab appears but shows no data, see [Missing signals or AEO opportunities](https://doc.sitecore.com/sai/en/users/sitecoreai/ai-discoverability-powered-by-scrunch/limitations-and-troubleshooting.html#missing-signals-or-aeo-opportunities).
