1. SitecoreAI CMS

Connect SitecoreAI CMS to Scrunch

Early access

This feature is currently available only to select Sitecore organizations. Reach out to your account or partner manager if you'd like to take part or want to learn more about Scrunch.

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

  1. Provision a Scrunch API key
  2. Add the API key in SitecoreAI Deploy
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.
    • The Organization Admin role and be on an eligible Scrunch plan. For more information about prerequisites, see the Scrunch documentation.

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, select the organization you want to work with.
  3. In the side navigation, in the Organization section, click API Keys > New API Key.
  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.

Add the API key in SitecoreAI Deploy

To add the Scrunch API key to your SitecoreAI Deploy environment:

  1. Log in to your Sitecore Cloud Portal 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 > Build and deploy. The environment will be redeployed.
  8. Click Options > Open Dashboard. Your site's Strategy page opens.
  9. After redeployment finishes, refresh the Strategy page. A Signals widget appears on the page.

This confirms that you've successfully connected SitecoreAI CMS to Scrunch. SitecoreAI organization members can now start working with signals.

Troubleshooting

If the Signals widget doesn't appear on the Strategy page, or if it displays the Couldn't load signals error, that's because SitecoreAI CMS and Scrunch are not connected.

To fix the issue:

  • Make sure your Scrunch API key is valid and that you entered it correctly in SitecoreAI Deploy. If the issue persists, create a new API key and add it in SitecoreAI Deploy.
  • Make sure the SitecoreAI Deploy environment variable name is AI_DISCOVERY_API_KEY because the connection requires this exact name.
  • Redeploy your Sitecore environment.
If you have suggestions for improving this article, let us know!