Normalize webhook payloads (#19110)

Co-authored-by: Andy Butland <[email protected]>
Co-authored-by: Kenn Jacobsen <[email protected]>

Author: 3 people

src/Umbraco.Core/Configuration/Models/WebhookSettings.cs

@@ -1,4 +1,5 @@
-using System.ComponentModel;
+using System.ComponentModel;
+using Umbraco.Cms.Core.Webhooks;
 
 namespace Umbraco.Cms.Core.Configuration.Models;
 
@@ -10,6 +11,7 @@ public class WebhookSettings
     internal const string StaticPeriod = "00:00:10";
     private const bool StaticEnableLoggingCleanup = true;
     private const int StaticKeepLogsForDays = 30;
+    private const WebhookPayloadType StaticPayloadType = Constants.Webhooks.DefaultPayloadType;
 
 
     /// <summary>
@@ -63,4 +65,16 @@ public class WebhookSettings
     /// </remarks>
     [DefaultValue(StaticKeepLogsForDays)]
     public int KeepLogsForDays { get; set; } = StaticKeepLogsForDays;
+
+    /// <summary>
+    ///     Gets or sets a value indicating the type of payload used for sending webhooks
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         By default, Legacy payloads are used see <see cref="WebhookPayloadType"/> for more info.
+    ///         This default will change to minimal starting from v17.
+    ///     </para>
+    /// </remarks>
+    [DefaultValue(StaticPayloadType)]
+    public WebhookPayloadType PayloadType { get; set; } = StaticPayloadType;
 }

src/Umbraco.Core/Constants-Configuration.cs

@@ -61,6 +61,7 @@ public static class Configuration
         public const string ConfigDataTypes = ConfigPrefix + "DataTypes";
         public const string ConfigPackageManifests = ConfigPrefix + "PackageManifests";
         public const string ConfigWebhook = ConfigPrefix + "Webhook";
+        public const string ConfigWebhookPayloadType = ConfigWebhook + ":PayloadType";
         public const string ConfigCache = ConfigPrefix + "Cache";
 
         public static class NamedOptions

src/Umbraco.Core/Constants-Webhooks.cs

@@ -0,0 +1,18 @@
+using Umbraco.Cms.Core.Webhooks;
+
+namespace Umbraco.Cms.Core;
+
+public static partial class Constants
+{
+    public static class Webhooks
+    {
+        /// <summary>
+        /// Gets the default webhook payload type.
+        /// </summary>
+        /// <remarks>
+        /// Currently, the default payload type is <see cref="WebhookPayloadType.Legacy"/> for backward compatibility until Umbraco 17.
+        /// From Umbraco 17 this will be changed to <see cref="WebhookPayloadType.Minimal"/>.
+        /// </remarks>
+        public const WebhookPayloadType DefaultPayloadType = WebhookPayloadType.Legacy;
+    }
+}

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Collections.cs

@@ -1,6 +1,8 @@
+using Microsoft.Extensions.Configuration;
 using Umbraco.Cms.Core.Actions;
 using Umbraco.Cms.Core.Cache;
 using Umbraco.Cms.Core.Composing;
+using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.DynamicRoot.Origin;
 using Umbraco.Cms.Core.DynamicRoot.QuerySteps;
@@ -91,7 +93,15 @@ internal static void AddAllCoreCollectionBuilders(this IUmbracoBuilder builder)
         builder.FilterHandlers().Add(() => builder.TypeLoader.GetTypes<IFilterHandler>());
         builder.SortHandlers().Add(() => builder.TypeLoader.GetTypes<ISortHandler>());
         builder.ContentIndexHandlers().Add(() => builder.TypeLoader.GetTypes<IContentIndexHandler>());
-        builder.WebhookEvents().AddCms(true);
+
+        WebhookPayloadType webhookPayloadType = Constants.Webhooks.DefaultPayloadType;
+        if (builder.Config.GetSection(Constants.Configuration.ConfigWebhookPayloadType).Value is not null)
+        {
+            webhookPayloadType = builder.Config.GetValue<WebhookPayloadType>(Constants.Configuration.ConfigWebhookPayloadType);
+        }
+
+        builder.WebhookEvents().AddCms(true, webhookPayloadType);
+
         builder.ContentTypeFilters();
     }
 

src/Umbraco.Core/Webhooks/Events/Content/ContentCopiedWebhookEvent.cs

@@ -28,10 +28,10 @@ public ContentCopiedWebhookEvent(
     {
         return new
         {
-            notification.Copy,
-            notification.Original,
-            notification.ParentId,
-            notification.RelateToOriginal
+            Id = notification.Copy.Key,
+            Original = notification.Original.Key,
+            Parent = notification.ParentKey,
+            notification.RelateToOriginal,
         };
     }
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentDeletedBlueprintWebhookEvent.cs

@@ -28,5 +28,5 @@ public ContentDeletedBlueprintWebhookEvent(
     protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentDeletedBlueprintNotification notification) =>
         notification.DeletedBlueprints;
 
-    protected override object ConvertEntityToRequestPayload(IContent entity) => entity;
+    protected override object ConvertEntityToRequestPayload(IContent entity) => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentDeletedVersionsWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -9,17 +10,21 @@ namespace Umbraco.Cms.Core.Webhooks.Events;
 [WebhookEvent("Content Versions Deleted", Constants.WebhookEvents.Types.Content)]
 public class ContentDeletedVersionsWebhookEvent : WebhookEventBase<ContentDeletedVersionsNotification>
 {
+    private readonly IIdKeyMap _idKeyMap;
+
     public ContentDeletedVersionsWebhookEvent(
         IWebhookFiringService webhookFiringService,
         IWebhookService webhookService,
         IOptionsMonitor<WebhookSettings> webhookSettings,
-        IServerRoleAccessor serverRoleAccessor)
+        IServerRoleAccessor serverRoleAccessor,
+        IIdKeyMap idKeyMap)
         : base(
             webhookFiringService,
             webhookService,
             webhookSettings,
             serverRoleAccessor)
     {
+        _idKeyMap = idKeyMap;
     }
 
     public override string Alias => Constants.WebhookEvents.Aliases.ContentDeletedVersions;
@@ -28,10 +33,10 @@ public ContentDeletedVersionsWebhookEvent(
     {
         return new
         {
-            notification.Id,
+            Id = _idKeyMap.GetKeyForId(notification.Id, UmbracoObjectTypes.Document).Result,
             notification.DeletePriorVersions,
             notification.SpecificVersion,
-            notification.DateToRetain
+            notification.DateToRetain,
         };
     }
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentDeletedWebhookEvent.cs

@@ -28,5 +28,6 @@ public ContentDeletedWebhookEvent(
     protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentDeletedNotification notification) =>
         notification.DeletedEntities;
 
-    protected override object ConvertEntityToRequestPayload(IContent entity) => new DefaultPayloadModel { Id = entity.Key };
+    protected override object ConvertEntityToRequestPayload(IContent entity)
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentEmptiedRecycleBinWebhookEvent.cs

@@ -34,5 +34,6 @@ public ContentEmptiedRecycleBinWebhookEvent(
     protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentEmptiedRecycleBinNotification notification) =>
         notification.DeletedEntities;
 
-    protected override object? ConvertEntityToRequestPayload(IContent entity) => entity;
+    protected override object? ConvertEntityToRequestPayload(IContent entity)
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentMovedToRecycleBinWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -25,5 +26,5 @@ public ContentMovedToRecycleBinWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.ContentMovedToRecycleBin;
 
     public override object? ConvertNotificationToRequestPayload(ContentMovedToRecycleBinNotification notification)
-        => notification.MoveInfoCollection;
+        => notification.MoveInfoCollection.Select(moveInfo => new DefaultPayloadModel { Id = moveInfo.Entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentMovedWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -25,5 +26,5 @@ public ContentMovedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.ContentMoved;
 
     public override object? ConvertNotificationToRequestPayload(ContentMovedNotification notification)
-        => notification.MoveInfoCollection;
+        => notification.MoveInfoCollection.Select(moveInfo => new DefaultPayloadModel { Id = moveInfo.Entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentPublishedWebhookEvent.cs

@@ -7,6 +7,7 @@
 using Umbraco.Cms.Core.PublishedCache;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
+using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.Webhooks.Events;
 
@@ -38,8 +39,13 @@ public ContentPublishedWebhookEvent(
     protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentPublishedNotification notification) => notification.PublishedEntities;
 
     protected override object? ConvertEntityToRequestPayload(IContent entity)
-    {
-        IPublishedContent? publishedContent = _publishedContentCache.GetById(entity.Key);
-        return publishedContent is null ? null : _apiContentBuilder.Build(publishedContent);
-    }
+        => new
+        {
+            Id = entity.Key,
+            Cultures = entity.PublishCultureInfos?.Values.Select(cultureInfo => new
+            {
+                cultureInfo.Culture,
+                cultureInfo.Date,
+            }),
+        };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentRolledBack.cs

@@ -39,9 +39,5 @@ protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentRoll
         new List<IContent> { notification.Entity };
 
     protected override object? ConvertEntityToRequestPayload(IContent entity)
-    {
-        // Get preview/saved version of content for a rollback
-        IPublishedContent? publishedContent = _contentCache.GetById(true, entity.Key);
-        return publishedContent is null ? null : _apiContentBuilder.Build(publishedContent);
-    }
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentSavedBlueprintWebhookEvent.cs

@@ -29,5 +29,6 @@ protected override IEnumerable<IContent>
         GetEntitiesFromNotification(ContentSavedBlueprintNotification notification)
             => new List<IContent> { notification.SavedBlueprint };
 
-    protected override object ConvertEntityToRequestPayload(IContent entity) => entity;
+    protected override object ConvertEntityToRequestPayload(IContent entity)
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentSavedWebhookEvent.cs

@@ -39,9 +39,5 @@ protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentSave
         notification.SavedEntities;
 
     protected override object? ConvertEntityToRequestPayload(IContent entity)
-    {
-        // Get preview/saved version of content
-        IPublishedContent? publishedContent = _contentCache.GetById(true, entity.Key);
-        return publishedContent is null ? null : _apiContentBuilder.Build(publishedContent);
-    }
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentSortedWebhookEvent.cs

@@ -36,14 +36,11 @@ public ContentSortedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.ContentSorted;
 
     public override object? ConvertNotificationToRequestPayload(ContentSortedNotification notification)
-    {
-        var sortedEntities = new List<object?>();
-        foreach (var entity in notification.SortedEntities)
-        {
-            IPublishedContent? publishedContent = _contentCache.GetById(entity.Key);
-            object? payload = publishedContent is null ? null : _apiContentBuilder.Build(publishedContent);
-            sortedEntities.Add(payload);
-        }
-        return sortedEntities;
-    }
+        => notification.SortedEntities
+            .OrderBy(entity => entity.SortOrder)
+            .Select(entity => new
+            {
+                Id = entity.Key,
+                entity.SortOrder,
+            });
 }

src/Umbraco.Core/Webhooks/Events/Content/ContentUnpublishedWebhookEvent.cs

@@ -27,5 +27,6 @@ public ContentUnpublishedWebhookEvent(
 
     protected override IEnumerable<IContent> GetEntitiesFromNotification(ContentUnpublishedNotification notification) => notification.UnpublishedEntities;
 
-    protected override object ConvertEntityToRequestPayload(IContent entity) => new DefaultPayloadModel { Id = entity.Key };
+    protected override object ConvertEntityToRequestPayload(IContent entity)
+        => new DefaultPayloadModel { Id = entity.Key };
 }

src/Umbraco.Core/Webhooks/Events/ContentType/DocumentTypeChangedWebhookEvent.cs

@@ -21,5 +21,9 @@ public DocumentTypeChangedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.DocumentTypeChanged;
 
     public override object? ConvertNotificationToRequestPayload(ContentTypeChangedNotification notification)
-        => notification.Changes;
+        => notification.Changes.Select(contentTypeChange => new
+        {
+            Id = contentTypeChange.Item.Key,
+            ContentTypeChange = contentTypeChange.ChangeTypes,
+        });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/DocumentTypeDeletedWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -21,5 +22,5 @@ public DocumentTypeDeletedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.DocumentTypeDeleted;
 
     public override object? ConvertNotificationToRequestPayload(ContentTypeDeletedNotification notification)
-        => notification.DeletedEntities;
+        => notification.DeletedEntities.Select(entity => new DefaultPayloadModel { Id = entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/DocumentTypeMovedWebhookEvent.cs

@@ -21,5 +21,9 @@ public DocumentTypeMovedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.DocumentTypeMoved;
 
     public override object? ConvertNotificationToRequestPayload(ContentTypeMovedNotification notification)
-        => notification.MoveInfoCollection;
+        => notification.MoveInfoCollection.Select(moveEvent => new
+        {
+            Id = moveEvent.Entity.Key,
+            NewParentId = moveEvent.NewParentKey,
+        });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/DocumentTypeSavedWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -21,5 +22,5 @@ public DocumentTypeSavedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.DocumentTypeSaved;
 
     public override object? ConvertNotificationToRequestPayload(ContentTypeSavedNotification notification)
-        => notification.SavedEntities;
+        => notification.SavedEntities.Select(entity => new DefaultPayloadModel { Id = entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/MediaTypeChangedWebhookEvent.cs

@@ -21,5 +21,9 @@ public MediaTypeChangedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.MediaTypeChanged;
 
     public override object? ConvertNotificationToRequestPayload(MediaTypeChangedNotification notification)
-        => notification.Changes;
+        => notification.Changes.Select(contentTypeChange => new
+        {
+            Id = contentTypeChange.Item.Key,
+            ContentTypeChange = contentTypeChange.ChangeTypes,
+        });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/MediaTypeDeletedWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -21,5 +22,5 @@ public MediaTypeDeletedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.MediaTypeDeleted;
 
     public override object? ConvertNotificationToRequestPayload(MediaTypeDeletedNotification notification)
-        => notification.DeletedEntities;
+        => notification.DeletedEntities.Select(entity => new DefaultPayloadModel { Id = entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/MediaTypeMovedWebhookEvent.cs

@@ -21,5 +21,9 @@ public MediaTypeMovedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.MediaTypeMoved;
 
     public override object? ConvertNotificationToRequestPayload(MediaTypeMovedNotification notification)
-        => notification.MoveInfoCollection;
+        => notification.MoveInfoCollection.Select(moveEvent => new
+        {
+            Id = moveEvent.Entity.Key,
+            NewParentId = moveEvent.NewParentKey,
+        });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/MediaTypeSavedWebhookEvent.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
@@ -21,5 +22,5 @@ public MediaTypeSavedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.MediaTypeSaved;
 
     public override object? ConvertNotificationToRequestPayload(MediaTypeSavedNotification notification)
-        => notification.SavedEntities;
+        => notification.SavedEntities.Select(entity => new DefaultPayloadModel { Id = entity.Key });
 }

src/Umbraco.Core/Webhooks/Events/ContentType/MemberTypeChangedWebhookEvent.cs

@@ -21,5 +21,9 @@ public MemberTypeChangedWebhookEvent(
     public override string Alias => Constants.WebhookEvents.Aliases.MemberTypeChanged;
 
     public override object? ConvertNotificationToRequestPayload(MemberTypeChangedNotification notification)
-        => notification.Changes;
+        => notification.Changes.Select(contentTypeChange => new
+        {
+            Id = contentTypeChange.Item.Key,
+            ContentTypeChange = contentTypeChange.ChangeTypes,
+        });
 }