{"id":6031,"date":"2015-11-07T08:56:48","date_gmt":"2015-11-07T08:56:48","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/webdev\/2015\/11\/07\/updates-to-microsoft-asp-net-webhooks-preview\/"},"modified":"2023-09-19T11:37:29","modified_gmt":"2023-09-19T18:37:29","slug":"updates-to-microsoft-asp-net-webhooks-preview","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/updates-to-microsoft-asp-net-webhooks-preview\/","title":{"rendered":"Updates to Microsoft ASP.NET WebHooks Preview"},"content":{"rendered":"

We just released Beta4 of ASP.NET WebHooks Preview with a nice set of new features based on feedback and help from the community! Always let us know what you think \u2013 either by raising a issue on GitHub<\/a> or pinging me on twitter<\/a>. You can get the update from nuget.org<\/a> by looking for the packages under Microsoft.AspNet.WebHooks.*<\/a>. If you haven\u2019t heard about ASP.NET WebHooks then you may want to look at Introducing Microsoft ASP.NET WebHooks Preview<\/a>.<\/p>\n

Here\u2019s what\u2019s new:<\/p>\n

Storing WebHook Registrations in SQL<\/h3>\n

This feature is from a pull request from Ryan Posener<\/a> — thanks! It enables storing Custom WebHook Registrations<\/a> in a SQL server. Before this we could store them in Azure Table Storage, but with support for SQL, developers have much more flexibility in where to store them. Now, when setting up custom WebHooks, you can include the Microsoft.AspNet.WebHooks.Custom.SqlStorage<\/a> package and wire it up in the WebApiConfig.cs<\/strong> file:<\/p>\n

\n
public<\/span> static<\/span> class<\/span> WebApiConfig
{
    public<\/span> static<\/span> void<\/span> Register(HttpConfiguration config)
    {
        \/\/ Web API routes<\/span>
        config.MapHttpAttributeRoutes();
        config.Routes.MapHttpRoute(
            name: "DefaultApi"<\/span>,
            routeTemplate: "api\/{controller}\/{id}"<\/span>,
            defaults: new<\/span> { id = RouteParameter.Optional }
        );
 
        \/\/ Load basic support for sending WebHooks<\/span>
        config.InitializeCustomWebHooks();
 
        \/\/ Use SQL for persisting subscriptions<\/span>
        config.InitializeCustomWebHooksSqlStorage();<\/font>
 
        \/\/ Load Web API controllers for managing subscriptions<\/span>
        config.InitializeCustomWebHooksApis();
    }
}<\/pre>\n
<\/div>\n
Set the connection string in the Web.config<\/strong> file of your Web Application project, something like this:<\/p>\n
\n
<<\/span>configuration<\/span>><\/span>
  ...
  <<\/span>connectionStrings<\/span>><\/span>
    ...
    <<\/span>add<\/span> name<\/span>="MS_SqlStoreConnectionString<\/font>"<\/span>
      connectionString<\/span>="Data Source=(LocalDb)MSSQLLocalDB;
                        Initial Catalog=WebHooks-20151029053732;Integrated Security=True"<\/span>
      providerName<\/span>="System.Data.SqlClient"<\/span> \/><\/span>
  <\/<\/span>connectionStrings<\/span>><\/span>
  ...
<\/<\/span>configuration<\/span>><\/span><\/pre>\n
 <\/div>\n
\"NugetConsole\"<\/a><\/div>\n
From the Package Manager Console run the following three commands, one after another, for initializing migrations and to initiate the DB:<\/p>\n
\n
Enable-Migrations -ContextAssemblyName Microsoft.AspNet.WebHooks.Custom.SqlStorage
Add-Migration WebHookStoreInitialDB
Update-Database<\/pre>\n
<\/div>\n
That\u2019s it \u2013 you are now ready to store WebHook registrations in your SQL server of choice! For a full example of how to use this, please see our new Custom WebHooks sample projects below.<\/p>\n
Custom WebHooks Sample Projects<\/h3>\n
We added two Custom WebHook sample projects following the path for setting up Custom WebHooks described in the blog Sending WebHooks with ASP.NET WebHooks Preview<\/a>. The CustomSender project<\/a> covers the sending part of Custom WebHooks and the CustomReceiver project<\/a> covers the receiving part. These sample projects (along with the other sample projects) hopefully make it simpler to try things out. <\/p>\n
Slack Slash Commands<\/h3>\n
Slash Commands<\/a> enable Slack users to interact with external services directly from Slack. Slash commands start with a slash \u2018\/\u2019 and can be wired up much like Outgoing WebHooks. That is, you can define a Slash Command to trigger an HTTP request with additional data to do something, for example:<\/p>\n
\n
\/henrik do something!<\/pre>\n
<\/div>\n
To set up a Slash Command you just follow the instructions for a Slash Command like this:<\/p>\n
\"SlashCommand\"<\/a><\/p>\n
On the ASP.NET WebHooks side, the setup works exactly as for Slack Outbound WebHooks described in the blog Integrating with Slack Using ASP.NET WebHooks Preview<\/a>. In addition, there now is a Slack sample<\/a> which you can also use.<\/p>\n
Instagram Receiver Improvements<\/h3>\n
We added some more types making it simpler to use Instagram WebHooks and also added a sample<\/a> illustrating the new model. Here\u2019s a sample handler looking for both image and videos (if present):<\/p>\n
\n
public<\/span> override<\/span> async Task ExecuteAsync(string<\/span> generator, WebHookHandlerContext context)
{
    \/\/ Get the WebHook client<\/span>
    InstagramWebHookClient client = Dependencies.Client;
 
    \/\/ Convert the incoming data to a collection of InstagramNotifications<\/span>
    var notifications = context.GetDataOrDefault<InstagramNotificationCollection>();
    foreach<\/span> (var notification in<\/span> notifications)
    {
        \/\/ Use WebHook client to get detailed information about the posted media<\/span>
        JArray entries = await client.GetRecentGeoMedia(context.Id, notification.ObjectId);
        foreach<\/span> (JToken entry in<\/span> entries)
        {
            InstagramPost post = entry.ToObject<InstagramPost>();
 
            \/\/ Image information<\/span>
            if<\/span> (post.Images != null<\/span>)
            {
                InstagramMedia thumbnail = post.Images.Thumbnail;
                InstagramMedia lowRes = post.Images.LowResolution;
                InstagramMedia stdRes = post.Images.StandardResolution;
            }
 
            \/\/ Video information<\/span>
            if<\/span> (post.Videos != null<\/span>)
            {
                InstagramMedia lowBandwidth = post.Videos.LowBandwidth;
                InstagramMedia lowRes = post.Videos.LowResolution;
                InstagramMedia stdRes = post.Videos.StandardResolution;
            }
 
            \/\/ Get direct links and sizes of media<\/span>
            Uri link = post.Link;
        }
    }
}
<\/pre>\n
<\/div>\n
Receivers Behind Firewalls<\/h3>\n
In certain cases, a WebHook receiver may sit behind a firewall or gateway that forwards requests as non-HTTPS requests, i.e. just as plain-text HTTP. In this case, the default WebHook receiver check that requires use of HTTPS will fail preventing the WebHook from being processed. This check can now be suppressed by setting the ‘MS_WebHookDisableHttpsCheck’ Application Setting to \u2018true\u2019. That is, if \u2018true\u2019 this will cause regular HTTP requests to go through. Obviously this setting should be used with caution!<\/p>\n
WebHookManager Updates<\/h3>\n
We added a constructor for WebHookManager<\/a> which enables wiring up the default IWebHookManager<\/a> implementation with a custom retry policy and the level of concurrency used when sending out event notifications in the form of WebHook requests. Here is an example of initializing Custom WebHooks using Autofac Dependency Injection<\/a> engine registering WebHookManager with a custom policy:<\/p>\n
\n
public<\/span> static<\/span> void<\/span> Register(HttpConfiguration config)
{
    \/\/ Web API routes<\/span>
    config.MapHttpAttributeRoutes();
    config.Routes.MapHttpRoute(
        name: "DefaultApi"<\/span>,
        routeTemplate: "api\/{controller}\/{id}"<\/span>,
        defaults: new<\/span> { id = RouteParameter.Optional }
    );
 
    \/\/ Load basic support for sending WebHooks<\/span>
    config.InitializeCustomWebHooks();
 
    \/\/ Load Azure Storage or SQL for persisting subscriptions<\/span>
    config.InitializeCustomWebHooksAzureStorage();
 
    \/\/ Load Web API controllers for managing subscriptions<\/span>
    config.InitializeCustomWebHooksApis();
 
    \/\/ Create custom WebHookManager with custom retry policy<\/span>
    ILogger logger = config.DependencyResolver.GetLogger();
    IWebHookStore store = config.DependencyResolver.GetStore();
    IWebHookManager manager = new<\/span> WebHookManager(store, logger, new<\/span> TimeSpan[] { }, null<\/span>);

 
    \/\/ Register WebHookManager with Autofac <\/span>
    ContainerBuilder builder = new<\/span> ContainerBuilder();
    builder.RegisterInstance(manager).As<IWebHookManager>().SingleInstance();
 
    \/\/ Register MVC and Web API controllers with Autofac<\/span>
    Assembly currentAssembly = Assembly.GetExecutingAssembly();
    builder.RegisterApiControllers(currentAssembly);
    builder.RegisterControllers(currentAssembly);
 
    \/\/ Build the Autofac container and set it as the dependency resolver for both MVC and Web API<\/span>
    IContainer container = builder.Build();
    DependencyResolver.SetResolver(new<\/span> AutofacDependencyResolver(container));
    config.DependencyResolver = new<\/span> AutofacWebApiDependencyResolver(container);
}
<\/p><\/pre>\n
<\/div>\n
We also added a new generic JSON WebHook receiver, but we will demonstrate that in a separate blog so stay tuned \ud83d\ude42<\/p>\n
Have fun and keep the feedback coming<\/a>!<\/p>\n
Henrik<\/p>\n","protected":false},"excerpt":{"rendered":"
We just released Beta4 of ASP.NET WebHooks Preview with a nice set of new features based on feedback and help from the community! Always let us know what you think \u2013 either by raising a issue on GitHub or pinging me on twitter. You can get the update from nuget.org by looking for the packages […]<\/p>\n","protected":false},"author":403,"featured_media":58792,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[34,7505,7506],"class_list":["post-6031","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-aspnet","tag-asp-net-web-api","tag-asp-net-webhooks","tag-webhooks"],"acf":[],"blog_post_summary":"
We just released Beta4 of ASP.NET WebHooks Preview with a nice set of new features based on feedback and help from the community! Always let us know what you think \u2013 either by raising a issue on GitHub or pinging me on twitter. You can get the update from nuget.org by looking for the packages […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/6031","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/403"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=6031"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/6031\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=6031"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=6031"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=6031"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Finally, you need to initialize Entity Framework Code First Migrations<\/a> to create and initialize the DB. In Visual Studio, open Package Manager Console<\/strong> from the ToolsNuget Package Manager<\/strong> menu and make sure your Web Application project is the Default Project:<\/div>\n