Headless

Discover how to integrate Umbraco.Engage.Headless package with Umbraco 12.0+ for a Content Delivery API.

Umbraco Engage offers the Umbraco.Engage.Headless package for seamless integration with Umbraco 12.0 and later. This package enables access to the Headless Content Delivery API, enabling personalized content, A/B tests, and segmentation.

All Engage features are supported except:

• Time on page tracking

• Video tracking (workaround could be to use the Events API)

• Form tracking

• Search term tracking (workaround could be to use the Events API)

• The Bridging Library for Google Analytics

• The Bridging Library for Google Tag Manager

• Google Analytics Blocker Detection

• Heatmap

• The Umbraco Engage Cockpit

Requirements

To install Umbraco.Engage.Headless, ensure the following prerequisites:

• Umbraco v13 is required to integrate with the Content Delivery API.

• Enable the Umbraco Content Delivery API by adding the following configuration setting in the appsettings.json file:

{
"Umbraco": {
    "CMS": {
        "DeliveryApi": {
            "Enabled": true
        }
    }
}
}

Installing the Umbraco Engage Headless API

To install the Umbraco Engage Headless API, follow these steps:

1. Install the Umbraco.Engage.Headless package:

• Using an IDE: Install the Umbraco.Engage.Headless package from NuGet in Visual Studio or JetBrains Rider.

• Using the command line:

  • Navigate to your Umbraco website root folder in your terminal.

  • Run the following command:

dotnet add package Umbraco.Engage.Headless

Updating Program.cs

To update the Program.cs file, follow these steps:

1. Open your Program.cs file.

2. Add the line .AddEngageApiDocumentation() after .AddDeliveryApi(). Your CreateUmbracoBuilder method should look like this:

builder.CreateUmbracoBuilder()
    .AddBackOffice()
    .AddWebsite()
    .AddDeliveryApi()
    .AddEngageApiDocumentation()
    .AddComposers()
    .Build();

1. Rebuild and run your site.

2. Navigate to /umbraco/swagger in your browser.

3. Check for the Umbraco Engage API from the top right definition dropdown.

Umbraco Engage API