Skip to main content

Sitecore

Sitecore Connector Setup Guide

The connector enables Ai12z to securely access and ingest content directly from your Sitecore instance. Once connected, Ai12z can automatically read, process, and integrate files or content that are added or published in Sitecore. This facilitates seamless content synchronization and real-time updates between your Sitecore environment and the Ai12z platform.

Enable Connector

  1. Log in to the Ai12z portal using admin credentials.
  2. Select or create an agent.
  3. From left nav select conectors.
  4. Click on Add Connectors button from the connector store configuration screen.
  5. Select the Sitecore connector from the list. ai12z Sitecore Connector

Step 1: Set up GraphQL IDE

Enable the GraphQL IDE

  1. To use the GraphQL IDE (Playground), ensure the following prerequisites and steps are met:

Prerequisites

  • You must be a member of the sitecore\Sitecore Client Users role to access the GraphQL IDE.
  • Enable GraphQL Playground
  • In XM Cloud Deploy, navigate to your project’s environment settings.
  • Create a new environment variable named Sitecore_GraphQL_ExposePlayground and set its value to true.
  • If the variable already exists, update its value to true.
  • Redeploy your environment to apply the new environment variable settings.
  • Save Authoring and Experience Edge URLs do above steps if this not available by default
  • Make a note of both the Authoring URL and Experience Edge URL — you’ll need these during connector setup.
  1. Create credentials
  • Go to deploy.sitecorecloud.io
  • Navigate to the Credentials section.
  • Click Create Credentials.
  • After creation, securely save the Client ID and Secret Key.(These will be required during the Sitecore connector setup.)
    • ai12z Sitecore Connector-Credentials

Step 2: Set Up Your Sitecore Webhook

To integrate your Sitecore environment with Ai12z, configure a webhook that triggers on specific content events.

  1. Select an envirnment from XM Cloud Switchbar
  2. Select Content Editor from the list
  3. Expand System > Webhooks
  4. Click on the "Webhook Event Handler" to create and configure the webhook
  • Fill in the required fields as described below.
  • Under Events, select only the following:
    1. item:added
    2. event:published
  • ai12z Sitecore Connector-Webhook
  1. Finish the webhook configuration as follows:
  • Name: Enter a name for your webhook (e.g., Ai12z Sitecore Webhook).
  • Description: Provide a short description (e.g., Triggers content sync with Ai12z on item add and publish).
  • Enabled: Ensure this is checked to activate the webhook.
  • Events: Select only the following events:
    1. item:added
    2. event:published
  • Url: Enter the secure HTTPS endpoint to receive webhook events.

Step 3: Fill Out the sitecore Connector Form in Ai12z Portal

  1. Select Connectors from the Agent left navigation.

  2. From the connector list, click on sitecore.

  3. Finish the connector configuration as follows:

    • Name:
      Enter a name for your connector (e.g., Sitecore Integration). This will appear in your document list.

    • Description:
      Provide a brief description of your connector (e.g., Connector for ingesting content from Sitecore CMS).

    • Public URL:
      Enter the public URL of your website (e.g., https://www.example.com).

    • Audience:
      Specify the intended audience value used for authentication.

    • Authoring URL:
      Provide the URL for your Sitecore authoring environment.

    • Client ID:
      Enter the Client ID generated in your Sitecore configuration for API access.

    • Client Secret:
      Enter the Client Secret associated with your Sitecore Client ID.

    • Sitecore Database:
      Sitecore Database

    • Tenant ID:
      Enter the Tenant ID associated with your Sitecore Identity Provider or environment.

    • ai12z Sitecore Connector-Form

  4. Click Save to complete the connector setup.