Webhooks administration from Backoffice

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

@@ -0,0 +1,34 @@
+using System.ComponentModel;
+
+namespace Umbraco.Cms.Core.Configuration.Models;
+
+[UmbracoOptions(Constants.Configuration.ConfigWebhook)]
+public class WebhookSettings
+{
+    private const bool StaticEnabled = true;
+    private const int StaticMaximumRetries = 5;
+
+    /// <summary>
+    ///     Gets or sets a value indicating whether webhooks are enabled.
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         By default, webhooks are enabled.
+    ///         If this option is set to <c>false</c> webhooks will no longer send web-requests.
+    ///     </para>
+    /// </remarks>
+    [DefaultValue(StaticEnabled)]
+    public bool Enabled { get; set; } = StaticEnabled;
+
+    /// <summary>
+    ///     Gets or sets a value indicating the maximum number of retries for all webhooks.
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         By default, maximum number of retries is 5.
+    ///         If this option is set to <c>0</c> webhooks will no longer retry.
+    ///     </para>
+    /// </remarks>
+    [DefaultValue(StaticMaximumRetries)]
+    public int MaximumRetries { get; set; } = StaticMaximumRetries;
+}

src/Umbraco.Core/Constants-Applications.cs

@@ -147,6 +147,8 @@ public static class Trees
 
         public const string LogViewer = "logViewer";
 
+        public const string Webhooks = "webhooks";
+
         public static class Groups
         {
             public const string Settings = "settingsGroup";

src/Umbraco.Core/Constants-Configuration.cs

@@ -64,6 +64,7 @@ public static class Configuration
         public const string ConfigHelpPage = ConfigPrefix + "HelpPage";
         public const string ConfigInstallDefaultData = ConfigPrefix + "InstallDefaultData";
         public const string ConfigDataTypes = ConfigPrefix + "DataTypes";
+        public const string ConfigWebhook = ConfigPrefix + "Webhook";
 
         public static class NamedOptions
         {

src/Umbraco.Core/Constants-Icons.cs

@@ -158,5 +158,10 @@ public static class Icons
         ///     System user group icon
         /// </summary>
         public const string UserGroup = "icon-users";
+
+        /// <summary>
+        ///     Webhooks icon
+        /// </summary>
+        public const string Webhooks = "icon-directions-alt";
     }
 }

src/Umbraco.Core/Constants-WebhookEvents.cs

@@ -0,0 +1,32 @@
+namespace Umbraco.Cms.Core;
+
+public static partial class Constants
+{
+    public static class WebhookEvents
+    {
+        /// <summary>
+        ///     Webhook event name for content publish.
+        /// </summary>
+        public const string ContentPublish = "ContentPublish";
+
+        /// <summary>
+        ///     Webhook event name for content delete.
+        /// </summary>
+        public const string ContentDelete = "ContentDelete";
+
+        /// <summary>
+        ///     Webhook event name for content unpublish.
+        /// </summary>
+        public const string ContentUnpublish = "ContentUnpublish";
+
+        /// <summary>
+        ///     Webhook event name for media delete.
+        /// </summary>
+        public const string MediaDelete = "MediaDelete";
+
+        /// <summary>
+        ///     Webhook event name for media save.
+        /// </summary>
+        public const string MediaSave = "MediaSave";
+    }
+}

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

@@ -19,6 +19,7 @@
 using Umbraco.Cms.Core.Tour;
 using Umbraco.Cms.Core.Trees;
 using Umbraco.Cms.Core.WebAssets;
+using Umbraco.Cms.Core.Webhooks;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.DependencyInjection;
@@ -128,6 +129,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().AddCoreWebhooks();
     }
 
     /// <summary>
@@ -195,6 +197,12 @@ public static MediaUrlProviderCollectionBuilder MediaUrlProviders(this IUmbracoB
     public static SectionCollectionBuilder Sections(this IUmbracoBuilder builder)
         => builder.WithCollectionBuilder<SectionCollectionBuilder>();
 
+    /// <summary>
+    /// Gets the backoffice sections/applications collection builder.
+    /// </summary>
+    /// <param name="builder">The builder.</param>
+    public static WebhookEventCollectionBuilder WebhookEvents(this IUmbracoBuilder builder) => builder.WithCollectionBuilder<WebhookEventCollectionBuilder>();
+
     /// <summary>
     /// Gets the components collection builder.
     /// </summary>

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

@@ -87,7 +87,8 @@ public static IUmbracoBuilder AddConfiguration(this IUmbracoBuilder builder)
             .AddUmbracoOptions<PackageMigrationSettings>()
             .AddUmbracoOptions<ContentDashboardSettings>()
             .AddUmbracoOptions<HelpPageSettings>()
-            .AddUmbracoOptions<DataTypesSettings>();
+            .AddUmbracoOptions<DataTypesSettings>()
+            .AddUmbracoOptions<WebhookSettings>();
 
         // Configure connection string and ensure it's updated when the configuration changes
         builder.Services.AddSingleton<IConfigureOptions<ConnectionStrings>, ConfigureConnectionStrings>();

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs

@@ -40,6 +40,7 @@
 using Umbraco.Cms.Core.Telemetry;
 using Umbraco.Cms.Core.Templates;
 using Umbraco.Cms.Core.Web;
+using Umbraco.Cms.Core.Webhooks;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.DependencyInjection
@@ -329,6 +330,9 @@ private void AddCoreServices()
 
             // Register filestream security analyzers
             Services.AddUnique<IFileStreamSecurityValidator,FileStreamSecurityValidator>();
+            Services.AddUnique<IWebHookService, WebhookService>();
+            Services.AddUnique<IWebhookLogService, WebhookLogService>();
+            Services.AddUnique<IWebhookLogFactory, WebhookLogFactory>();
         }
     }
 }

src/Umbraco.Core/EmbeddedResources/Lang/da.xml

@@ -1004,6 +1004,12 @@
     <key alias="welcomeIntro">
       <![CDATA[Denne guide vil bringe dig gennem konfigurationsprocessen af <strong>Umbraco %0%</strong> for en frisk installation eller for en opgradering fra version 3.0.<br/><br/>Tryk på <strong>Næste</strong> for at begynde på guiden.]]></key>
   </area>
+  <area alias="webhooks">
+    <key alias="addWebhook">Opret webhook</key>
+    <key alias="addWebhookHeader">Tilføj webhook header</key>
+    <key alias="addDocumentType">Tilføj dokument type</key>
+    <key alias="addMediaType">Tilføj medie Type</key>
+  </area>
   <area alias="language">
     <key alias="cultureCode">Culture Code</key>
     <key alias="displayName">Culture Name</key>

src/Umbraco.Core/EmbeddedResources/Lang/en_us.xml

@@ -1975,6 +1975,13 @@ To manage your website, simply open the Umbraco backoffice and start adding cont
     <key alias="historyCleanupGloballyDisabled"><![CDATA[<strong>NOTE!</strong> The cleanup of historically content versions are disabled globally. These settings will not take effect before it is enabled.]]></key>
     <key alias="changeDataTypeHelpText">Changing a data type with stored values is disabled. To allow this you can change the Umbraco:CMS:DataTypes:CanBeChanged setting in appsettings.json.</key>
   </area>
+  <area alias="webhooks">
+    <key alias="addWebhook">Create webhook</key>
+    <key alias="addWebhookHeader">Add webhook header</key>
+    <key alias="logs">Logs</key>
+    <key alias="addDocumentType">Add Document Type</key>
+    <key alias="addMediaType">Add Media Type</key>
+  </area>
   <area alias="languages">
     <key alias="addLanguage">Add language</key>
     <key alias="culture">ISO code</key>
@@ -2119,6 +2126,7 @@ To manage your website, simply open the Umbraco backoffice and start adding cont
     <key alias="settingsGroup">Settings</key>
     <key alias="templatingGroup">Templating</key>
     <key alias="thirdPartyGroup">Third Party</key>
+    <key alias="webhooks">Webhooks</key>
   </area>
   <area alias="update">
     <key alias="updateAvailable">New update ready</key>

src/Umbraco.Core/Models/DefaultPayloadModel.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Cms.Core.Models;
+
+internal class DefaultPayloadModel
+{
+    public Guid Id { get; set; }
+}

src/Umbraco.Core/Models/Webhook.cs

@@ -0,0 +1,27 @@
+namespace Umbraco.Cms.Core.Models;
+
+public class Webhook
+{
+    public Webhook(string url, bool? enabled = null, Guid[]? entityKeys = null, string[]? events = null, IDictionary<string, string>? headers = null)
+    {
+        Url = url;
+        Headers = headers ?? new Dictionary<string, string>();
+        Events = events ?? Array.Empty<string>();
+        ContentTypeKeys = entityKeys ?? Array.Empty<Guid>();
+        Enabled = enabled ?? false;
+    }
+
+    public int Id { get; set; }
+
+    public Guid Key { get; set; }
+
+    public string Url { get; set; }
+
+    public string[] Events { get; set; }
+
+    public Guid[] ContentTypeKeys {get; set; }
+
+    public bool Enabled { get; set; }
+
+    public IDictionary<string, string> Headers { get; set; }
+}

src/Umbraco.Core/Models/WebhookLog.cs

@@ -0,0 +1,28 @@
+namespace Umbraco.Cms.Core.Models;
+
+public class WebhookLog
+{
+    public int Id { get; set; }
+
+    public Guid WebhookKey { get; set; }
+
+    public Guid Key { get; set; }
+
+    public string Url { get; set; } = string.Empty;
+
+    public string StatusCode { get; set; } = string.Empty;
+
+    public DateTime Date { get; set; }
+
+    public string EventName { get; set; } = string.Empty;
+
+    public int RetryCount { get; set; }
+
+    public string RequestHeaders { get; set; } = string.Empty;
+
+    public string? RequestBody { get; set; } = string.Empty;
+
+    public string ResponseHeaders { get; set; } = string.Empty;
+
+    public string ResponseBody { get; set; } = string.Empty;
+}

src/Umbraco.Core/Models/WebhookResponseModel.cs

@@ -0,0 +1,8 @@
+namespace Umbraco.Cms.Core.Models;
+
+public class WebhookResponseModel
+{
+    public HttpResponseMessage? HttpResponseMessage { get; set; }
+
+    public int RetryCount { get; set; }
+}

src/Umbraco.Core/PaginationHelper.cs

@@ -0,0 +1,15 @@
+namespace Umbraco.Cms.Core;
+
+public static class PaginationHelper
+{
+    public static void ConvertSkipTakeToPaging(int skip, int take, out long pageNumber, out int pageSize)
+    {
+        if (skip % take != 0)
+        {
+            throw new ArgumentException("Invalid skip/take, Skip must be a multiple of take - i.e. skip = 10, take = 5");
+        }
+
+        pageSize = take;
+        pageNumber = skip / take;
+    }
+}

src/Umbraco.Core/Persistence/Constants-DatabaseSchema.cs

@@ -86,6 +86,11 @@ public static class Tables
             public const string LogViewerQuery = TableNamePrefix + "LogViewerQuery";
 
             public const string CreatedPackageSchema = TableNamePrefix + "CreatedPackageSchema";
+            public const string Webhook = TableNamePrefix + "Webhook";
+            public const string Webhook2ContentTypeKeys = Webhook + "2ContentTypeKeys";
+            public const string Webhook2Events = Webhook + "2Events";
+            public const string Webhook2Headers = Webhook + "2Headers";
+            public const string WebhookLog = TableNamePrefix + "WebhookLog";
         }
     }
 }

src/Umbraco.Core/Persistence/Repositories/IWebhookLogRepository.cs

@@ -0,0 +1,11 @@
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.Webhooks;
+
+namespace Umbraco.Cms.Core.Persistence.Repositories;
+
+public interface IWebhookLogRepository
+{
+    Task CreateAsync(WebhookLog log);
+
+    Task<PagedModel<WebhookLog>> GetPagedAsync(int skip, int take);
+}

src/Umbraco.Core/Persistence/Repositories/IWebhookRepository.cs

@@ -0,0 +1,49 @@
+using Umbraco.Cms.Core.Models;
+
+namespace Umbraco.Cms.Core.Persistence.Repositories;
+
+public interface IWebhookRepository
+{
+    /// <summary>
+    ///     Gets all of the webhooks in the current database.
+    /// </summary>
+    /// <param name="skip">Number of entries to skip.</param>
+    /// <param name="take">Number of entries to take.</param>
+    /// <returns>A paged model of <see cref="Webhook" /> objects.</returns>
+    Task<PagedModel<Webhook>> GetAllAsync(int skip, int take);
+
+    /// <summary>
+    ///     Gets all of the webhooks in the current database.
+    /// </summary>
+    /// <param name="webhook">The webhook you want to create.</param>
+    /// <returns>The created <see cref="Webhook" /> webhook</returns>
+    Task<Webhook> CreateAsync(Webhook webhook);
+
+    /// <summary>
+    ///     Gets a webhook by key
+    /// </summary>
+    /// <param name="key">The key of the webhook which will be retrieved.</param>
+    /// <returns>The <see cref="Webhook" /> webhook with the given key.</returns>
+    Task<Webhook?> GetAsync(Guid key);
+
+    /// <summary>
+    ///     Gets a webhook by key
+    /// </summary>
+    /// <param name="eventName">The key of the webhook which will be retrieved.</param>
+    /// <returns>The <see cref="Webhook" /> webhook with the given key.</returns>
+    Task<PagedModel<Webhook>> GetByEventNameAsync(string eventName);
+
+    /// <summary>
+    ///     Gets a webhook by key
+    /// </summary>
+    /// <param name="webhook">The webhook to be deleted.</param>
+    /// <returns><placeholder>A <see cref="Task"/> representing the asynchronous operation.</placeholder></returns>
+    Task DeleteAsync(Webhook webhook);
+
+    /// <summary>
+    ///     Updates a given webhook
+    /// </summary>
+    /// <param name="webhook">The webhook to be updated.</param>
+    /// <returns>The updated <see cref="Webhook" /> webhook.</returns>
+    Task UpdateAsync(Webhook webhook);
+}

src/Umbraco.Core/Services/IWebHookService.cs

@@ -0,0 +1,18 @@
+using Umbraco.Cms.Core.Models;
+
+namespace Umbraco.Cms.Core.Services;
+
+public interface IWebHookService
+{
+    Task<Webhook> CreateAsync(Webhook webhook);
+
+    Task UpdateAsync(Webhook webhook);
+
+    Task DeleteAsync(Guid key);
+
+    Task<Webhook?> GetAsync(Guid key);
+
+    Task<PagedModel<Webhook>> GetAllAsync(int skip, int take);
+
+    Task<IEnumerable<Webhook>> GetByEventNameAsync(string eventName);
+}

src/Umbraco.Core/Services/IWebhookFiringService.cs

@@ -0,0 +1,8 @@
+using Umbraco.Cms.Core.Models;
+
+namespace Umbraco.Cms.Core.Services;
+
+public interface IWebhookFiringService
+{
+    Task FireAsync(Webhook webhook, string eventName, object? payload, CancellationToken cancellationToken);
+}

src/Umbraco.Core/Services/IWebhookLogFactory.cs

@@ -0,0 +1,9 @@
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.Webhooks;
+
+namespace Umbraco.Cms.Core.Services;
+
+public interface IWebhookLogFactory
+{
+    Task<WebhookLog> CreateAsync(string eventName, WebhookResponseModel responseModel, Webhook webhook, CancellationToken cancellationToken);
+}