Umbraco Engage
CMSCloudHeartcoreDXP
13.latest (LTS)
13.latest (LTS)
  • Umbraco Engage Documentation
  • Release Notes
  • Support
  • Installation
    • System Requirements
    • Installation
    • Licensing
    • Verify your Engage installation
  • Upgrading
    • Upgrade Umbraco Engage
    • Version specific Upgrade Notes
    • Migrate from uMarketingSuite
  • Getting Started
    • Getting Started
    • For Marketers and Editors
      • Cockpit
      • Marketing Resources
    • For Developers
      • Infrastructure sizing
      • Load Balancing and CM/CD Environments
      • Content Delivery Network recommendations
      • Cockpit
      • Content Security Policy nonce configuration
      • Troubleshooting installations
  • Marketers and Editors
    • Introduction
      • The Umbraco Engage Section
      • Content Apps
      • The Umbraco Engage Cookie
    • Analytics
      • What is measured by default
      • Client-side Events
      • Types Of Clients
      • Campaigns
      • Device Type
      • Location
      • Referral Traffic
      • Forms
      • Videos
      • Scroll Heatmap
      • Google Analytics vs Umbraco Engage
      • Search Terms
    • A/B Testing
      • What is A/B testing
      • Types of A/B Tests
        • Single-page A/B Test
        • Multiple Pages Test
        • Document Type Test
        • Split URL Test
      • Setting up the A/B Test
      • Previewing an A/B Test
      • Monitor the A/B Test
      • A/B Test Distribution Algorithm
      • Front end Rendering
      • Finish an A/B Test
    • Personalization
      • Creating a Segment
      • Setting up Personalization
      • Cockpit Insights
      • Implicit and Explicit Personalization
        • Setting up the customer journey
        • Personas
        • Implicit Personalization scoring explained
        • Content Scoring
        • Campaign Scoring
        • Referral Scoring
    • Profiling
      • Profile detail
      • External profile data
    • Reporting
    • Settings
      • Goals
      • IP Filtering
      • Configuration
      • Permissions
  • Developers
    • Introduction
      • Dataflow Pipeline
        • Data Collection
        • Data Storage
        • Data Parsing
        • Reporting
      • The Umbraco Engage Cookie
        • Module Permissions
      • Performance
    • Analytics
      • Request tracking
      • Bot detection
      • Capture location data
      • Extending forms
      • Video tracking
      • Scroll Heatmap
      • Client-side events
        • Additional measurements with analytics scripts
        • Bridging Library for Google Analytics
        • Bridging Library for Google Tag Manager
        • Google Analytics Blocker Detection
        • Create your own events
      • Extending Analytics
        • Getting the Correct IP Address
        • Sending data to the GTM Datalayer
    • A/B testing
      • Retrieving A/B test variants in C#
    • Personalization
      • Implement your own segment parameters
      • Retrieve segment information from code
      • Add custom scoring
    • Profiling
      • External Profile Data
    • Reporting
    • Settings
      • Custom goals scoring
      • Configuration
    • Headless
      • Using the Engage API
      • Headless Example
  • Security and Privacy
    • Security and privacy
    • Retention periods of data
    • Anonymization
    • GDPR & EU regulation
      • How to become GDPR compliant using cookiebot
    • How it works
  • Tutorials
    • Overview
    • How to Get Started with Personalization
    • How to Create a Persona
    • Create a Personalized Popup in 5 minutes
    • How to set up an A/B Test
    • Marketing Resources
      • Generic Topbar Template
      • Generic Popup Template
      • Generic Exit Intent Popup Template
Powered by GitBook
On this page
  • Requirements
  • Installing the Umbraco Engage Headless API
  • Updating Program.cs

Was this helpful?

Edit on GitHub
Export as PDF
  1. Developers

Headless

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

PreviousConfigurationNextUsing the Engage API

Last updated 4 months ago

Was this helpful?

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 Analytics 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

  • The

Requirements

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

  • Umbraco v13 is required to integrate with the .

  • Enable the 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.

Bridging Library for Google Analytics
Bridging Library for Google Tag Manager
Google Analytics Blocker Detection
Content Delivery API
Umbraco Content Delivery API
Umbraco Engage API