Clean.Headless 7.0.0-preview5

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
This is a prerelease version of Clean.Headless.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Clean.Headless --version 7.0.0-preview5
                    


                    

                
NuGet\Install-Package Clean.Headless -Version 7.0.0-preview5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Clean.Headless" Version="7.0.0-preview5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Clean.Headless" Version="7.0.0-preview5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Clean.Headless" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Clean.Headless --version 7.0.0-preview5
                    


                    

                
#r "nuget: Clean.Headless, 7.0.0-preview5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Clean.Headless@7.0.0-preview5
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Clean.Headless&version=7.0.0-preview5&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Clean.Headless&version=7.0.0-preview5&prerelease
                    


                            Install as a Cake Tool

Clean.Headless

Headless CMS extension for the Clean Starter Kit for Umbraco, providing API controllers and Next.js revalidation support for building modern headless applications.

Description

Clean.Headless extends the Clean Starter Kit with headless CMS capabilities, including:

  • API Controllers: RESTful API endpoints for dictionary, search, and contact functionality
  • Next.js Revalidation: Automatic webhook-based revalidation for Next.js applications
  • Content Delivery API Integration: Full integration with Umbraco's Content Delivery API
  • OpenAPI Documentation: Swagger UI support for exploring and testing API endpoints

Installation

This package is automatically installed as a dependency of the main Clean package. However, you can also install it independently:

dotnet add package Clean.Headless

Configuration

Enable Content Delivery API

Update your appsettings.json to enable the Content Delivery API:

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

Configure Next.js Revalidation (Optional)

To enable automatic revalidation of content in Next.js applications:

{
  "NextJs": {
    "Revalidate": {
      "Enabled": true,
      "WebHookUrls": "[\"http://localhost:3000/api/revalidate\"]",
      "WebHookSecret": "SOMETHING_SECRET"
    }
  }
}

API Endpoints

Clean.Headless provides several API endpoints:

  • Dictionary API: Access translation/dictionary items
  • Search API: Perform content searches
  • Contact API: Handle contact form submissions

OpenAPI/Swagger Documentation

Explore the API endpoints using the built-in Swagger UI:

URL: /umbraco/swagger/index.html?urls.primaryName=Clean%20starter%20kit

Requirements

  • Umbraco.Cms.Web.Website 17.0.0-rc2 or higher
  • Umbraco.Cms.Api.Common 17.0.0-rc2 or higher
  • .NET 10.0

Version Compatibility

Clean.Headless Version Umbraco Version .NET Version
4.x 13 .NET 8
5.x 15 .NET 9
6.x 16 .NET 9
7.x 17 .NET 10

Headless Frontend Example

Check out the Clean Starter Kit Headless Frontend - a complete Next.js implementation demonstrating headless CMS integration.

Documentation

For complete documentation and examples, visit the Clean Starter Kit repository.

Support

License

MIT License - see the LICENSE file for details.

Authors

  • Paul Seal
  • Phil Whittaker
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Clean.Headless:

Package Downloads
Clean

Clean Starter Kit for Umbraco

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
7.0.5 767 1/8/2026
7.0.4 146 1/5/2026
7.0.3 778 12/11/2025
7.0.2 503 12/9/2025
7.0.1 524 11/30/2025
7.0.0 367 11/27/2025
7.0.0-rc4 215 11/26/2025
7.0.0-preview9 197 11/23/2025
7.0.0-preview8 195 11/23/2025
7.0.0-preview7 173 11/23/2025
7.0.0-preview6 173 11/23/2025
7.0.0-preview5 181 11/22/2025
7.0.0-preview17 199 11/26/2025
7.0.0-preview16 184 11/26/2025
7.0.0-preview15 193 11/25/2025
7.0.0-preview14 198 11/25/2025
7.0.0-preview13 189 11/25/2025
7.0.0-preview12 191 11/25/2025
7.0.0-preview11 191 11/23/2025
7.0.0-preview10 193 11/23/2025
Loading failed