Use fluent API for adding webhook events and add document type events (…

…#15345)

* Move adding webhooks to extension methods

* Clean up WebhookEventCollectionBuilder

* Rename AddAllAvailableWebhooks to AddCmsWebhooks and internalize defaults

* Use fluent CmsWebhookEventCollectionBuilder for adding CMS specific webhook events

* Split media and media type webhook events

* Use fluent CmsUserWebhookEventCollectionBuilder for adding CMS user specific webhook events

* Rename extension methods and add onlyDefault parameter

* Remove duplicate UserForgotPasswordRequestedWebhookEvent

* Add document type webhook events and use fluent builders for content and content types

* Use fluent WebhookEventCollectionBuilderCmsMember for adding member/member group webhook events

* Use fluent WebhookEventCollectionBuilderCmsTemplate for template/partial view webhook events

* Use fluent WebhookEventCollectionBuilderCmsFile for file based webhook events (instead of only template/partial view)

* Move all webhook events to Umbraco.Cms.Core.Webhooks.Events namespace

* Reorder AddFile method and update documentation

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

@@ -145,7 +145,7 @@ 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().AddDefaultWebhooks();
+        builder.WebhookEvents().AddCms(true);
     }
 
     /// <summary>

src/Umbraco.Core/Umbraco.Core.csproj

@@ -11,11 +11,11 @@
     <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Physical" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
-    <PackageReference Include="Microsoft.Extensions.Identity.Core"  />
+    <PackageReference Include="Microsoft.Extensions.Identity.Core" />
     <PackageReference Include="Microsoft.Extensions.Logging" />
     <PackageReference Include="Microsoft.Extensions.Options" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions"/>
-    <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations"/>
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" />
+    <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" />
     <PackageReference Include="System.Runtime.Caching" />
   </ItemGroup>
 

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Copied", Constants.WebhookEvents.Types.Content)]
 public class ContentCopiedWebhookEvent : WebhookEventBase<ContentCopiedNotification>

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

@@ -1,11 +1,11 @@
-using Microsoft.Extensions.Options;
+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;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Template [Blueprint] Deleted", Constants.WebhookEvents.Types.Content)]
 public class ContentDeletedBlueprintWebhookEvent : WebhookEventContentBase<ContentDeletedBlueprintNotification, IContent>

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Versions Deleted", Constants.WebhookEvents.Types.Content)]
 public class ContentDeletedVersionsWebhookEvent : WebhookEventBase<ContentDeletedVersionsNotification>

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

@@ -1,11 +1,11 @@
-using Microsoft.Extensions.Options;
+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;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Deleted", Constants.WebhookEvents.Types.Content)]
 public class ContentDeletedWebhookEvent : WebhookEventContentBase<ContentDeletedNotification, IContent>

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

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.Models;
@@ -7,7 +7,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Recycle Bin Emptied", Constants.WebhookEvents.Types.Content)]
 public class ContentEmptiedRecycleBinWebhookEvent : WebhookEventContentBase<ContentEmptiedRecycleBinNotification, IContent>

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Moved to Recycle Bin", Constants.WebhookEvents.Types.Content)]
 public class ContentMovedToRecycleBinWebhookEvent : WebhookEventBase<ContentMovedToRecycleBinNotification>

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Moved", Constants.WebhookEvents.Types.Content)]
 public class ContentMovedWebhookEvent : WebhookEventBase<ContentMovedNotification>

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

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.Models;
@@ -8,7 +8,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Published", Constants.WebhookEvents.Types.Content)]
 public class ContentPublishedWebhookEvent : WebhookEventContentBase<ContentPublishedNotification, IContent>

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

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.Models;
@@ -8,7 +8,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Rolled Back", Constants.WebhookEvents.Types.Content)]
 public class ContentRolledBackWebhookEvent : WebhookEventContentBase<ContentRolledBackNotification, IContent>

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

@@ -1,11 +1,11 @@
-using Microsoft.Extensions.Options;
+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;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Template [Blueprint] Saved", Constants.WebhookEvents.Types.Content)]
 public class ContentSavedBlueprintWebhookEvent : WebhookEventContentBase<ContentSavedBlueprintNotification, IContent>

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

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.Models;
@@ -8,7 +8,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Saved", Constants.WebhookEvents.Types.Content)]
 public class ContentSavedWebhookEvent : WebhookEventContentBase<ContentSavedNotification, IContent>

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

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DeliveryApi;
 using Umbraco.Cms.Core.Models;
@@ -8,7 +8,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Sorted", Constants.WebhookEvents.Types.Content)]
 public class ContentSortedWebhookEvent : WebhookEventBase<ContentSortedNotification>

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

@@ -1,11 +1,11 @@
-using Microsoft.Extensions.Options;
+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;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.Content;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Content Unpublished", Constants.WebhookEvents.Types.Content)]
 public class ContentUnpublishedWebhookEvent : WebhookEventContentBase<ContentUnpublishedNotification, IContent>

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

@@ -0,0 +1,25 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Sync;
+
+namespace Umbraco.Cms.Core.Webhooks.Events;
+
+[WebhookEvent("Document Type Changed")]
+public class DocumentTypeChangedWebhookEvent : WebhookEventBase<ContentTypeChangedNotification>
+{
+    public DocumentTypeChangedWebhookEvent(
+        IWebhookFiringService webhookFiringService,
+        IWebhookService webHookService,
+        IOptionsMonitor<WebhookSettings> webhookSettings,
+        IServerRoleAccessor serverRoleAccessor)
+        : base(webhookFiringService, webHookService, webhookSettings, serverRoleAccessor)
+    {
+    }
+
+    public override string Alias => "documentTypeChanged";
+
+    public override object? ConvertNotificationToRequestPayload(ContentTypeChangedNotification notification)
+        => notification.Changes;
+}

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

@@ -0,0 +1,25 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Sync;
+
+namespace Umbraco.Cms.Core.Webhooks.Events;
+
+[WebhookEvent("Document Type Deleted")]
+public class DocumentTypeDeletedWebhookEvent : WebhookEventBase<ContentTypeDeletedNotification>
+{
+    public DocumentTypeDeletedWebhookEvent(
+        IWebhookFiringService webhookFiringService,
+        IWebhookService webHookService,
+        IOptionsMonitor<WebhookSettings> webhookSettings,
+        IServerRoleAccessor serverRoleAccessor)
+        : base(webhookFiringService, webHookService, webhookSettings, serverRoleAccessor)
+    {
+    }
+
+    public override string Alias => "documentTypeDeleted";
+
+    public override object? ConvertNotificationToRequestPayload(ContentTypeDeletedNotification notification)
+        => notification.DeletedEntities;
+}

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

@@ -0,0 +1,25 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Sync;
+
+namespace Umbraco.Cms.Core.Webhooks.Events;
+
+[WebhookEvent("Document Type Moved")]
+public class DocumentTypeMovedWebhookEvent : WebhookEventBase<ContentTypeMovedNotification>
+{
+    public DocumentTypeMovedWebhookEvent(
+        IWebhookFiringService webhookFiringService,
+        IWebhookService webHookService,
+        IOptionsMonitor<WebhookSettings> webhookSettings,
+        IServerRoleAccessor serverRoleAccessor)
+        : base(webhookFiringService, webHookService, webhookSettings, serverRoleAccessor)
+    {
+    }
+
+    public override string Alias => "documentTypeMoved";
+
+    public override object? ConvertNotificationToRequestPayload(ContentTypeMovedNotification notification)
+        => notification.MoveInfoCollection;
+}

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

@@ -0,0 +1,25 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Notifications;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Sync;
+
+namespace Umbraco.Cms.Core.Webhooks.Events;
+
+[WebhookEvent("Document Type Saved")]
+public class DocumentTypeSavedWebhookEvent : WebhookEventBase<ContentTypeSavedNotification>
+{
+    public DocumentTypeSavedWebhookEvent(
+        IWebhookFiringService webhookFiringService,
+        IWebhookService webHookService,
+        IOptionsMonitor<WebhookSettings> webhookSettings,
+        IServerRoleAccessor serverRoleAccessor)
+        : base(webhookFiringService, webHookService, webhookSettings, serverRoleAccessor)
+    {
+    }
+
+    public override string Alias => "documentTypeSaved";
+
+    public override object? ConvertNotificationToRequestPayload(ContentTypeSavedNotification notification)
+        => notification.SavedEntities;
+}

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MediaType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Media Type Changed")]
 public class MediaTypeChangedWebhookEvent : WebhookEventBase<MediaTypeChangedNotification>

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

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MediaType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Media Type Deleted")]
 public class MediaTypeDeletedWebhookEvent : WebhookEventBase<MediaTypeDeletedNotification>

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

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MediaType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Media Type Moved")]
 public class MediaTypeMovedWebhookEvent : WebhookEventBase<MediaTypeMovedNotification>

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

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MediaType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Media Type Saved")]
 public class MediaTypeSavedWebhookEvent : WebhookEventBase<MediaTypeSavedNotification>

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

@@ -1,10 +1,10 @@
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.Notifications;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MemberType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Member Type Changed")]
 public class MemberTypeChangedWebhookEvent : WebhookEventBase<MemberTypeChangedNotification>

src/Umbraco.Core/Webhooks/Events/MemberType/MemberTypeDeletedWebhookEvent.cs → src/Umbraco.Core/Webhooks/Events/ContentType/MemberTypeDeletedWebhookEvent.cs

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MemberType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Member Type Deleted")]
 public class MemberTypeDeletedWebhookEvent : WebhookEventBase<MemberTypeDeletedNotification>

src/Umbraco.Core/Webhooks/Events/MemberType/MemberTypeMovedWebhookEvent.cs → src/Umbraco.Core/Webhooks/Events/ContentType/MemberTypeMovedWebhookEvent.cs

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MemberType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Member Type Moved")]
 public class MemberTypeMovedWebhookEvent : WebhookEventBase<MemberTypeMovedNotification>

src/Umbraco.Core/Webhooks/Events/MemberType/MemberTypeSavedWebhookEvent.cs → src/Umbraco.Core/Webhooks/Events/ContentType/MemberTypeSavedWebhookEvent.cs

@@ -4,7 +4,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Sync;
 
-namespace Umbraco.Cms.Core.Webhooks.Events.MemberType;
+namespace Umbraco.Cms.Core.Webhooks.Events;
 
 [WebhookEvent("Member Type Saved")]
 public class MemberTypeSavedWebhookEvent : WebhookEventBase<MemberTypeSavedNotification>