Working with Webhooks in Sitecore - Part 2

In my previous blog, we discussed the concept of Webhooks. In this blog, we will set up a simple webhook in Sitecore. 

To understand the implementation better I have kept the things very simple. So in this example, I will be using No Authorization Item. Talking about it in brief then, you need to set up an Authorization item if your endpoint webhook requires Authentication. Although I would strongly recommend to use Authorization to keep your endpoint safe and secure in real scenarios. 

Webhook authentication types 

Currently in Sitecore, there are 5 types of Authentication available.

1. Basic : This requires username and password fields.

2. Digest : This requires username and password fields.

3. API Key : This requires Key, Value and Add to fields.

4. OAuth2.0 Client Credentials Grant : This requires Authority URL, Client ID, Client Secret, Scope, Header Prefix (The default value is Bearer), Additional endpoint base addresses fields.

5. OAuth2.0 Password Credentials Grant : This requires Authority URL, Client ID, Client Secret, Scope, Header Prefix (The default value is Bearer), Username, Password, Additional endpoint base addresses 

Webhook Endpoint 

Lets set up an endpoint first. This endpoint will receive data in JSON format. As discussed earlier, your endpoint could be in any code base. But to test, we can use Online tools which provide us the endpoint url. 

For this example, I will be using webhook.site to show the data we get thru POST. So once you open the site, it will show you like below: 


 So that’s your endpoint which is listening to some data

 Sitecore Webhook Setup 

Step 1: The first step is to create Webhook Event Handler. 

For this open Content Editor and go to /sitecore/system/Webhooks path. 


Step 2: Create New Item named Sample - Site 1 - Item Added

 


Please note that I have added item_added event as selection. That means if any item is created then it will post the json data related to same item to the configured webhook url.

Step 3: Configure the webhook endpoint

 

Keeping this example as simple, I have not added any rules. BUT rules must be added so that you can filter the actions. 

The value in the URL field is the same to the webhook link which I have created webhook.site and make sure you enabled the webhook. 

And that’s it. Your webhook is all set to test. 

Step 4: Testing the webhook. 

To test this, create any item under home item, like below:

Once created, then lets see webhook.site 


 In above snapshot you can see that all the item details are pushed from Sitecore to webhook url.

Comments

Post a Comment

Popular posts from this blog

Working with Device Detection Module in Sitecore

Image
  What is Device Detection in Sitecore? Sitecore has an in-built feature called Device Detection which helps to detect at which device the content is shown into. When I say in-built that means its included as a standard feature in Sitecore XP 9.0 and later. This feature is also present in Sitecore XM Cloud , hence you do not need to buy a separate add-on or module to utilize device detection features.   The information gather from Device Detection Module can help content makers, allowing them to tailor the website experience based on the device type they are accessing it with, such as by displaying different layouts or content depending on screen size and capabilities. For Example, An iPhone and Android users might be looking at different content on same page.   Moreover, developers uses the same mechanism to personalize the components based on the device specific audience. They can setup Device Layout based on specific device parameters or can use the in-built rules...
Read more

Setup A/B Testing in Sitecore - Part 1

Image
  Setup A/B Testing in Sitecore - Part 1 In this article we will understand What is A/B Testing, Types of Testing in Sitecore, Actual Use Case and later we will see how we can setup A/B Testing in Sitecore XP solution with Rendering having different data source items.   Before we go further, lets understand WHAT IS A/B Testing ? A/B testing, also known as split testing, is a method used in marketing and product development to compare two versions of something to determine which one performs better. In an A/B test, two versions, A and B, are created, with one varying element between them. This element could be anything from the wording of an email subject line, the design of a web page, the placement of a button, or even the pricing of a product.   The versions, A and B, are then randomly  shown to similar audiences or users, and their responses are measured and compared. The version that performs better in terms of predefined metrics (such as click-through rate, conv...
Read more

Working with Webhooks in Sitecore - Part 1

Image
  Working with Webhooks in Sitecore - Part 1 In this blog we will understand the concept of Webhooks and how we can use them in Sitecore. So before jumping into Webhooks in Sitecore, first lets understand what webhooks are?   What is a Webhook? They are typically created to connect/link different applications. They are much like API but different from them. Webhooks are one way that apps can send automated messages or information to other apps.   Consider an example below:     Suppose, there is a user facing front application which showcase the product catalogs to its customers. This application is responsible for booking an order from its users. BUT the logistics is handle by different application.   The second application (logistic app) has setup a webhook which is exposed over http and waiting to receive any confirmed orders. Once someone place any order which can be called as an event for the first application, then along with its operation it is passin...
Read more