K Khan
Jan 4, 2016
  2594
(1 votes)

Integrate solutions via aspnet webhooks

Webhooks are "user-defined HTTP callbacks". They are usually triggered by some event, such as pushing code to a repository or a comment being posted to a blog. When that event occurs, the source site makes an HTTP request to the URI configured for the webhook. Users can configure them to cause events on one site to invoke behaviour on another. The action taken may be anything. Common uses are to trigger builds with continuous integration systems or to notify bug tracking systems. Since they use HTTP, they can be integrated into web services without adding new infrastructure.

WebHook framework for ASP.NET (available in pre release at Nuget) gives you a pattern for:

  • Handling subscriptions from interested subscribers
  • Sending subscriptions to publishers
  • Sending published messages to subscribers
  • Handling publisher messages from subscribed services (via Receivers)

Image 20160101_100939-1.jpg

To fit this with EPiServer I have developed a Storage manager based on EPiServer DDS and Controller to deal with sunbscribers. This blog is to get the initial feed back that what general events clients will like to subscribe generally, Code is available on git. I am still working on an interface to allow editors to subscribe other websites.

With current solution solution,To make a sender application you will require to add dlls in your server. Using this Javascript subscribers can be added. I am using Alloy site.

<script>
    function subscribe() {
    $.ajax({
        type: "POST",
        url: "/api/EpiServerWebHookRegistrations/Subscribe",
        data: JSON.stringify({
            WebURI: "http://localhost:51481",
            Secret: "12345678901234567890123456789012",
            Description: "WebHook for entry updating!",
            Services: "contentschanged"
        }),
        contentType: "application/json; charset=utf-8",
        dataType: "json",
        success: function(data, status) { alert(data.Message ? data.Message : status); },
        error: function (errMsg) { alert(errMsg.responseJSON.Message); }
    });
    return false;
}

function unsubscribe() {
    $.ajax({
        url: "/api/webhooks/registrations",
        type: 'DELETE',
        success: function (data, status) { alert(data.Message ? data.Message : status); },
        error: function (errMsg) { alert(errMsg.responseJSON.Message); }
    });
    return false;
}

</script>

To implement receiver you will have to implement a handler and few settings in web.config. (Please see this blog)

and Happy New Year!

Jan 04, 2016

Comments

Please login to comment.
Latest blogs
Enhance Your Writing with Suggestions

Are you tired of staring at a blank screen, struggling to find the right words? The Epicweb.Optimizely.AIAssistant Addon is here to revolutionize...

Luc Gosso (MVP) | May 31, 2023 | Syndicated blog

Content Graph - Letting GraphQL do all the hard work for you

Background As we have seen before, setting up Content Graph on the CMS side is pretty easy. However, when it comes to the “head” part of the setup,...

Kunal Shetye | May 26, 2023 | Syndicated blog

Improved headless functionality in Customized Commerce

Did you know that with the release of Content Delivery Commerce API 3.7 we have massively improved the out of the box headless capabilities of...

Marcus Hoffmann | May 25, 2023

Boost Your Productivity with the AI Assistant Addon for Optimizely Content Cloud

In today's fast-paced digital world, efficiency and convenience are paramount. That's why we're excited to introduce the Optimizely AI-Assistant...

Luc Gosso (MVP) | May 25, 2023 | Syndicated blog